Get Scraper Data
The Get Scraper Data endpoint returns information about your Scraper API access, including your scraper API key, remaining credits, concurrency limit, and the scraper endpoint URL.
Endpoint
GET https://api.evomi.com/public/scraper
Authentication
Requires API key in either:
x-apikeyheaderapikeyquery parameter
Example Request
curl -X GET "https://api.evomi.com/public/scraper" \
-H "x-apikey: YOUR_API_KEY"Or via query parameter:
curl -X GET "https://api.evomi.com/public/scraper?apikey=YOUR_API_KEY"Response (User Has Access)
{
"success": true,
"has_access": true,
"credits": 847.5,
"concurrency": 5,
"api_key": "abc123def456ghi",
"endpoint_url": "https://scrape.evomi.com/api/v1"
}Response (User Has No Access)
{
"success": true,
"has_access": false,
"credits": 0,
"concurrency": 0,
"api_key": null,
"endpoint_url": "https://scrape.evomi.com/api/v1"
}Fields in the Response
| Field | Type | Description |
|---|---|---|
success |
boolean | Whether the request was processed successfully |
has_access |
boolean | Whether the user has access to the Scraper API |
credits |
number (decimal) | Remaining scraper credits |
concurrency |
integer | Maximum number of concurrent scraper requests |
api_key |
string | null | Your Scraper API key, or null if you don’t have access |
endpoint_url |
string | The Scraper API endpoint URL |
âšī¸
The
api_key returned here is your Scraper API key, used to authenticate requests against the scraper endpoint. It is distinct from the Evomi public API key used to call this endpoint.Error Responses
- 401 Unauthorized: The API key provided is either missing or invalid. Ensure that you are passing the correct API key either in the URL or in the request header.
- 500 Internal Server Error: This indicates a problem on our server side. Please contact support if you encounter this error.
For more information on how to authenticate your requests, check out the Authentication page.