JSON POST request example
POST to https://api.litescrape.com/api/npm/package with Content-Type: application/json and your Authorization: Bearer header.
{
"package": "requests"
}// request reference
npm Package parameters
Send query parameters with GET /api/npm/package. 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
packagenpm package name, including an optional scope, such as @vue/server-renderer.
Type string · GET query or POST JSON
Example / input hint: requests
- Maximum characters: 214
- Pattern: ^(?:@[a-z0-9][a-z0-9._-]*/)?[a-z0-9][a-z0-9._-]*$
versionPublished version or distribution tag. Defaults to latest.
Type string · GET query or POST JSON · Default latest
- Minimum characters: 1
- Maximum characters: 100
- Pattern: ^[A-Za-z0-9][A-Za-z0-9._+-]*$
// 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, package, 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": {
"package": "requests",
"version": "latest"
},
"package": {
"name": "requests",
"version": "0.3.0",
"description": "An streaming XHR abstraction that works in browsers and node.js",
"license": "MIT",
"homepage": "https://github.com/unshiftio/requests",
"dependencies": {
"axo": "0.0.x",
"hang": "1.0.x",
"loads": "0.0.x",
"xhr-send": "1.0.x",
"extendible": "0.1.x",
"eventemitter3": "~4.0.0",
"node-http-xhr": "~1.3.0"
},
"peer_dependencies": {},
"engines": {}
},
"submit_feedback_for_this_response_here": "https://api.litescrape.com/api/feedback/example-not-a-valid-token"
}