{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"81c8b9f6-3c89-44ee-8950-8adb41709fa5","name":"Grepsr APIs","description":"Send requests to the Grepsr app remotely. Get all data access functionalities of the app from within your API tool — query collected data, manage scheduling and even run reports on-demand!!\n\n# Authorization\n\nAll API requests require an **`X-Api-Key`** header for authentication.\n\n### **How to Get Your API Key**\n\n1. Log in to your Grepsr account.\n    \n2. Navigate to **Profile**.\n    \n3. Locate your **API Key** under the **Personal Details** section.\n    \n\n### **Using the API Key**\n\n- Include it in the headers of every request:\n    \n\n```\nX-Api-Key: {{your_api_key}}\n\n ```\n\n- **Security Note:** Treat your API key as sensitive—avoid exposing it in client-side code or public repositories.\n    \n\n# Rate Limiting\n\nTo ensure fair usage, the API enforces rate limits.\n\n### **Current Limits**\n\n- **100 requests per minute** per user (across all endpoints).\n    \n- Exceeding this limit returns a **`429 Too Many Requests`** error.\n    \n\n### **Rate Limit Headers**\n\nEach response includes:\n\n| Header | Description |\n| --- | --- |\n| `x-ratelimit-limit-minute` | Maximum allowed requests per minute. |\n| `x-ratelimit-remaining-minute` | Remaining requests in the current window. |\n\n### **Handling Rate Limits**\n\n- **Check remaining requests** before making additional calls.\n    \n- **Implement exponential backoff** if you hit a `429` response.\n    \n- **Cache responses** where possible to reduce API calls.\n    \n\n# Variables\n\nVariable(s) used in this documentation:\n\n| Variable | Value | Description |\n| --- | --- | --- |\n| `{{apikey}}` | `X-API-Key` | Your personal API key, available in the _Account_ section in the app |\n\n**IMPORTANT**\n\n- Replace all instances of {{your_api_key}} with whatever variable name you choose for your personalized values while executing the requests.\n    \n- Unless otherwise specified, add [https://api.grepsr.com](https://api.grepsr.com) as the URL prefix for each request.\n    \n- For each request to work, make sure you enter project_id, report_id, history_id, service_id, etc. of a project that YOU own!\n    \n\n# Key Concepts\n\nTo query data directly via our API, it is important to understand certain concepts. We have tried to explain every basic concept using Excel as an analogy.\n\n|  |  |\n| --- | --- |\n| **Record** | Individual data row in a report. |\n| **Report** | A collection of records; like a folder which contains crawled data. |\n| **History** | Individual batch of a crawl run. When a crawler runs, it uses a report's specification to create a run history. One history is equivalent to one Excel file/workbook. |\n| **Project** | A collection of reports. |\n\n# Errors\n\nCommon Errors:\n\n| Error Code | Response Body Message | Description |\n| --- | --- | --- |\n| 400 | `Required parameter not supplied` | Bad Request |\n| 401 | `No API key found in request` | Unauthorized |\n| 404 | `Not Found` | Page Not Found |\n| 429 | `Too Many Requests` | Too Many Requests(RateLimit exceeded) |\n| 500 | `Internal server error` | Internal Server Error |\n\n### **Error Response Format**\n\n``` json\n{\n  \"status\": false,\n  \"message\": \"Error description\",\n  \"payload\": null\n}\n\n ```\n\n## **Best Practices**\n\n✅ **Store your API key securely** (environment variables, secret managers).  \n✅ **Monitor rate limits** using response headers.  \n✅ **Implement retry logic** for failed requests (with delays).  \n✅ **Use pagination** when fetching large datasets.\n\n## **Support**\n\nFor higher rate limits or troubleshooting, contact **Grepsr Support(**[<b>support@grepsr.com</b>](https://mailto:support@grepsr.com)**)**.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31997238","team":5926980,"collectionId":"81c8b9f6-3c89-44ee-8950-8adb41709fa5","publishedId":"2s9Ykt5eaS","public":true,"publicUrl":"https://api-docs.grepsr.com","privateUrl":"https://go.postman.co/documentation/31997238-81c8b9f6-3c89-44ee-8950-8adb41709fa5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Grepsr API Documentation"},{"name":"title","value":"Grepsr API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-01-15T05:26:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Grepsr API Documentation","description":"Grepsr API Documentation"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d5d7d2c906d051de46eac716c4f38e933a15749473be317fc861b54c0143a87d","favicon":"https://res.cloudinary.com/postman/image/upload/v1705220772/team/epzwv5ouazmpt5xawoxe.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.grepsr.com/view/metadata/2s9Ykt5eaS"}