OpenAPI Spec

The machine-readable description of every endpoint.

The full surface of the API is described in an OpenAPI 3.1 document. It is the source of truth for the API reference and for every generated client.

curl -O https://developers.firsty.app/api-reference/openapi.json

Generating a client

Any OpenAPI-compatible generator will work:

npx openapi-typescript openapi.json -o firsty-api.d.ts

The spec is versioned alongside the API (info.version). Pin the version you generated against so a future additive change doesn't silently alter your types.