Skip to content

These three endpoints never cost credits.

Endpoint Auth Returns
GET /me X-API-Key Your account, plan and credit balance
GET /endpoints none Every endpoint with its parameters, price and a sample response
GET /openapi.json none An OpenAPI 3.0 spec generated from the same catalog

Checks a key and shows your balance. Integrations use it as their connection test.

Terminal window
curl "https://api.scrapier.io/api/v2/me" \
-H "X-API-Key: YOUR_API_KEY"
{
"user_id": "…",
"key_id": "…",
"email": "[email protected]",
"name": "…",
"credits": { "balance": 9871 },
"plan": "Pro"
}

email, name, credits and plan are each left out if they can’t be looked up, and plan is left out when you have no active subscription. Code defensively, for example body.credits?.balance.

The public, machine-readable catalog of every endpoint. No key needed.

Terminal window
curl "https://api.scrapier.io/api/v2/endpoints"
{
"base_url": "https://api.scrapier.io/api/v2",
"auth": { "type": "apiKey", "header": "X-API-Key" },
"billing": "Credits are charged per successful call; each endpoint lists its cost_credit per call. Failed calls are free.",
"endpoints": [
{
"platform": "google",
"apis": [
{
"endpoint": "/google-maps/",
"cost_credit": 1,
"input": {
"queries": {
"type": "string",
"required": true,
"description": "Place search keyword. Required first call. …",
"default_value": "coffee shops"
}
},
"sample_output": {
"formatted": { "queries": "coffee shops", "places": ["…"], "next_cursor": "…" },
"raw": { "queries": "coffee shops", "raw_responses": ["…"], "next_cursor": "…" }
}
}
]
}
]
}
  • input maps each parameter to its type (string, integer or boolean), required, description, default_value and, for some, options.
  • default_value is always a string, even for integers and booleans ("50", "true").
  • sample_output holds two samples. formatted is the data part of a normal successful response, without the {"success", "data"} wrapper. raw is what you get with raw_data=true (see API conventions). Older snapshots may show the formatted object directly.
  • The catalog refreshes about every 15 minutes, so new endpoints show up here first. It’s the best source for agents and code generators: read an endpoint’s input before calling it.
Terminal window
curl "https://api.scrapier.io/api/v2/openapi.json"

An OpenAPI 3.0 document with one GET and one POST operation per endpoint, usable in Postman, Insomnia and similar tools. See OpenAPI & Postman.