JSON POST request example
POST to https://api.litescrape.com/api/github/user with Content-Type: application/json and your Authorization: Bearer header.
{
"username": "python"
}// request reference
GitHub User parameters
Send query parameters with GET /api/github/user. 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
usernameGitHub username or organization name.
Type string · GET query or POST JSON
Example / input hint: python
- Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$
// 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, user, 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": {
"username": "python"
},
"user": {
"login": "python",
"id": 1525981,
"html_url": "https://github.com/python",
"avatar_url": "https://avatars.githubusercontent.com/u/1525981?v=4",
"name": "Python",
"company": null,
"blog": "https://www.python.org/",
"location": null,
"bio": "Repositories related to the Python Programming language",
"public_repos": 98,
"followers": 32792,
"following": 0,
"created_at": "2012-03-11T15:56:37Z"
},
"submit_feedback_for_this_response_here": "https://api.litescrape.com/api/feedback/example-not-a-valid-token"
}