JSON POST request example
POST to https://api.litescrape.com/api/github/search with Content-Type: application/json and your Authorization: Bearer header.
{
"q": "python",
"limit": 2
}// request reference
GitHub Repository Search parameters
Send query parameters with GET /api/github/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
qRepository search terms and GitHub qualifiers, up to 256 characters; for example, language:python.
Type string · GET query or POST JSON
Example / input hint: python
- Minimum characters: 1
- Maximum characters: 256
sortRepository ranking: best_match, stars, forks, or updated.
Type string · GET query or POST JSON · Default best_match
best_matchstarsforksupdatedorderSort direction.
Type string · GET query or POST JSON · Default desc
descascpageOne-based results page. Search exposes at most the first 1,000 results.
Type integer · GET query or POST JSON · Default 1
- Minimum: 1
- Maximum: 1000
limitMaximum results per page, from 1 to 100.
Type integer · GET query or POST JSON · Default 30
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, repositories, total_results, incomplete_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": "python",
"sort": "best_match",
"order": "desc",
"page": 1,
"limit": 2
},
"repositories": [
{
"id": 63476337,
"name": "Python",
"full_name": "TheAlgorithms/Python",
"html_url": "https://github.com/TheAlgorithms/Python",
"description": "All Algorithms implemented in Python",
"homepage": "https://thealgorithms.github.io/Python/",
"language": "Python",
"stargazers_count": 225472,
"forks_count": 51205,
"open_issues_count": 45,
"archived": false,
"topics": [
"algorithm",
"algorithm-competitions",
"algorithms-implemented",
"algos",
"community-driven",
"education",
"hacktoberfest",
"interview",
"learn",
"practice",
"python",
"searches",
"sorting-algorithms",
"sorts"
],
"created_at": "2016-07-16T09:44:01Z",
"updated_at": "2026-10-23T07:43:17Z",
"pushed_at": "2026-10-20T05:01:26Z"
},
{
"id": 2881789,
"name": "Python",
"full_name": "geekcomputers/Python",
"html_url": "https://github.com/geekcomputers/Python",
"description": "My Python Examples",
"homepage": "http://www.thegeekblog.co.uk",
"language": "Python",
"stargazers_count": 35439,
"forks_count": 12921,
"open_issues_count": 505,
"archived": false,
"topics": [],
"created_at": "2011-11-30T09:04:08Z",
"updated_at": "2026-10-23T07:48:19Z",
"pushed_at": "2026-10-16T14:41:01Z"
}
],
"total_results": 7414651,
"incomplete_results": false,
"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"
}