OpenAPI¶

The full OpenAPI 3.1 document for the /v1 surface is published as a release asset (openapi.json) and rendered interactively here.

Static download¶

openapi.json

This file is regenerated on every docs build (and pinned into each GitHub release as openapi.json).

Code generation¶

Use it with any OpenAPI-aware generator:

# TypeScript types
npx openapi-typescript https://sfmapi.github.io/_static/openapi.json -o sfmapi.d.ts

# Full client
npx @openapitools/openapi-generator-cli generate \
    -i https://sfmapi.github.io/_static/openapi.json \
    -g python -o ./gen-python

Our own SDKs (sfmapi-client for Python and @sfmapi/client for TypeScript) are hand-rolled rather than generated, but the OpenAPI document is the source of truth either way.