CarrySpec API

A REST API over HTTPS that answers in JSON. Every page here is generated from the API's own OpenAPI document, so it says what the API does today.

Base URL

https://carryspec.com/api/v1

Authentication

Send an API key as Authorization: Bearer bk_…. Make one on the API page of your account; the Authentication guide has the rest.

Errors and limits

Every refusal has one shape, {"error": {"code", "message"}}. Each answer to a key carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. See Errors & limits and Pagination.

To send a real request from the browser, use Swagger, on the API's own address.

Endpoints

Catalogue

Sources, categories, products, price history.

• GET/api/v1/categoriesList the categories
• GET/api/v1/coloursList the colour families
• GET/api/v1/productsList products
• GET/api/v1/products/{product_id}Get one product
• GET/api/v1/products/{product_id}/pricesGet a product's price history
• GET/api/v1/sourcesList the sources

Events

The changes: a feed to read or to follow.

• GET/api/v1/event-typesList the kinds of event
• GET/api/v1/eventsList what changed

Alerts

Which changes to hear about, and where.

• GET/api/v1/alertsList your alerts
• POST/api/v1/alertsMake an alert
• GET/api/v1/alerts/feedList what your alerts caught
• GET/api/v1/alerts/{alert_id}Get one alert
• DELETE/api/v1/alerts/{alert_id}Delete an alert
• PATCH/api/v1/alerts/{alert_id}Change an alert
• GET/api/v1/alerts/{alert_id}/deliveriesList what was sent to an alert's webhook
• POST/api/v1/alerts/{alert_id}/testSend a test to an alert's webhook

Account

Whose key this is, its plan and its limits.

• GET/api/v1/meGet the account

Status

Whether the service is up.

• GET/api/healthCheck the service is up