> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Discovery endpoints

Three free endpoints for tooling and agents - /me for your account and balance, /endpoints for the full catalog, /openapi.json for an OpenAPI spec.

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             |

## GET /me

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

```bash
curl "https://api.scrapier.io/api/v2/me" \
  -H "X-API-Key: YOUR_API_KEY"
```

```json
{
  "user_id": "…",
  "key_id": "…",
  "email": "you@example.com",
  "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`.

## GET /endpoints

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

```bash
curl "https://api.scrapier.io/api/v2/endpoints"
```

```json
{
  "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](https://docs.scrapier.io/conventions.md#raw-upstream-payload-raw_data)). 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.

## GET /openapi.json

```bash
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](https://docs.scrapier.io/integrations/openapi.md).

> **Note:** The spec has parameter defaults and the error responses, but describes each endpoint's `data` generically (an open object with `next_cursor`). For per-endpoint result fields and sample responses, use `sample_output` from `GET /endpoints` or the endpoint pages.
