# npm Registry Search API (https://www.socialcrawl.dev/platforms/npm/search) > Returns the npm packages matching search terms, ranked by npm, 20 a page by default and up to 100, for up to 100 pages, with npm's total for the search. Search terms take npm's own qualifiers, for example keywords:react or author:sindresorhus. Each package is a Post: the package name (`post.id` and `post.ext.title`, the name GET /v1/npm/package takes), its npm page and description (`post.content.text`). `post.ext.npm` adds the latest version, licence, homepage, repository, keywords, maintainers by username, when the version was published, weekly and monthly downloads and the number of dependents. Pass the returned cursor for the next page. TL;DR: `GET /v1/npm/search` costs 1 credit per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup. ## Parameters | Parameter | Required | Description | | --- | --- | --- | | `query` | yes | Search terms, 1 to 300 characters, for example react state, with npm qualifiers such as keywords:hooks. | | `page` | no | Page number from 1 to 100. Prefer the universal cursor parameter. | | `limit` | no | Packages per page, 1 to 100. Defaults to 20. | | `since` | no | Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`. | | `until` | no | Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`. | | `max_pages` | no | 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped. | | `max_items` | no | 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue. | | `max_credits` | no | 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price. | ## Code example ```bash curl -G "https://www.socialcrawl.dev/v1/npm/search" \ --data-urlencode "query=react state" \ -H "x-api-key: sc_YOUR_API_KEY" ``` ## FAQ ### How do I search npm with an API? Send GET /v1/npm/search with your terms as query. npm qualifiers such as keywords:cli or author:name work too. ### How many packages come back per call? 20 by default and up to 100 with limit, for up to 100 pages, with npm's total. Pass the returned cursor for the next page. ### What does each result include? The package name, npm page, description, and in post.ext.npm the latest version, licence, links, keywords, maintainers, downloads and dependents. ### How do I read a result in detail? Pass its name to GET /v1/npm/package for that version's dependencies and tarball. ### Does a search with no match cost a credit? An empty result is refunded automatically, and bad parameters return 400 without a charge. See the full npm Registry API: https://www.socialcrawl.dev/platforms/npm ## Pricing - Standard endpoints: 1 credit per call - Advanced endpoints: 5 credits per call - Premium endpoints: 10 credits per call - 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire. - Full pricing: https://www.socialcrawl.dev/pricing ## Explore with AI Questions this API answers, phrased for an AI assistant: - How do I search npm packages with an API? - Which API returns npm packages with weekly downloads?