# OpenAPI specification

> The ShopSavvy Data API OpenAPI 3.0 spec at api.shopsavvy.com/v1/openapi.json: import it into Postman or Insomnia, or generate a client.

*Source: https://shopsavvy.com/data/documentation/openapi* · Part of the [ShopSavvy Data API documentation](https://shopsavvy.com/data/documentation.md)

---

The full API description is published as OpenAPI 3.0 at:

```
https://api.shopsavvy.com/v1/openapi.json
```

It needs no API key. It lists every endpoint with its parameters, response schemas, error responses and credit cost (in each operation's `x-credit-cost`), so you can:

- Import it into Postman or Insomnia: **Import > Link** and paste the URL.
- Generate a client: `npx @openapitools/openapi-generator-cli generate -i https://api.shopsavvy.com/v1/openapi.json -g python -o shopsavvy-client` (or use one of the [official SDKs](https://shopsavvy.com/data/documentation/sdk-typescript)).
- Point an agent or tool at it. It is also listed in [`/.well-known/api-catalog`](https://shopsavvy.com/.well-known/api-catalog) and [`/apis.json`](https://shopsavvy.com/apis.json).