JSON POST request example
POST to https://api.litescrape.com/api/npm/search with Content-Type: application/json and your Authorization: Bearer header.
{
"q": "react",
"limit": 2
}// request reference
npm Search parameters
Send query parameters with GET /api/npm/search. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.
Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.
Request parameters
qPackage search terms and npm search qualifiers.
Type string · GET query or POST JSON
Example / input hint: react
- Minimum characters: 1
- Maximum characters: 500
pageOne-based results page.
Type integer · GET query or POST JSON · Default 1
- Minimum: 1
- Maximum: 1000
limitMaximum packages per page, from 1 to 100.
Type integer · GET query or POST JSON · Default 20
Example / input hint: 2
- Minimum: 1
- Maximum: 100
// response
Work with the complete JSON response
Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.
Response groups include search_parameters, packages, total_results, pagination, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.
Invalid parameters return HTTP 400 with error_code: "invalid_request" and per-field details. Unavailable resources return HTTP 404 with error_code: "not_found". Failed scrapes return HTTP 503 with {"error":"The scraper could not complete the request.","error_code":"service_unavailable"}. Failed requests are not billed.
Illustrative success response. Result groups and optional fields depend on upstream content.
{
"search_parameters": {
"q": "react",
"page": 1,
"limit": 2
},
"packages": [
{
"name": "react",
"version": "19.3.1",
"description": "React is a JavaScript library for building user interfaces.",
"license": "MIT",
"homepage": "https://react.dev/"
},
{
"name": "react-is",
"version": "19.3.1",
"description": "Brand checking of React Elements.",
"license": "MIT",
"homepage": "https://react.dev/"
}
],
"total_results": 551829,
"pagination": {
"has_more": true,
"next_page": 2,
"next_page_token": null
},
"submit_feedback_for_this_response_here": "https://api.litescrape.com/api/feedback/example-not-a-valid-token"
}