> 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`.

# OpenAPI & Postman

Import the Scrapier OpenAPI spec into Postman, Insomnia, Bruno or a code generator.

Scrapier publishes an OpenAPI 3.0 spec generated from the live endpoint catalog:

```text
https://api.scrapier.io/api/v2/openapi.json
```

It's public and free (no key needed).

> **Note:** The spec covers every v2 endpoint with parameter defaults, the `X-API-Key` security scheme and the error responses. Each endpoint's `data` object is described generically (an open object with `next_cursor`), so for the result fields and a sample response, see the [endpoint pages](https://docs.scrapier.io/api-reference.md) or `sample_output` in [`GET /api/v2/endpoints`](https://api.scrapier.io/api/v2/endpoints).

## Postman

1. In Postman, click **Import** and paste `https://api.scrapier.io/api/v2/openapi.json`.
2. Import it as a collection.
3. In the collection's **Authorization** settings (or on each request), add the header `X-API-Key` with your key.
4. Keep the trailing slash on endpoint paths, e.g. `/google-maps/`.

## Insomnia and Bruno

Both import OpenAPI 3 specs from a URL or file: use their **Import** option with the same URL, then set the `X-API-Key` header on the collection or environment.

## Tips

- Every endpoint accepts both `GET` (query string) and `POST` (JSON body). See [API conventions](https://docs.scrapier.io/conventions.md).
- Required inputs are not needed on later pages when you send a `cursor`. Some generated clients treat them as always required; if yours does, use the plain request instead. See [Pagination](https://docs.scrapier.io/pagination.md).
- Set client timeouts to at least 210 seconds. See [Rate limits & reliability](https://docs.scrapier.io/rate-limits.md).
