Docs
DashboardGet API key
Tools

OpenAPI spec

The Soldgraph OpenAPI 3.1 spec, for generating typed clients in any language and importing the API into Postman, Insomnia or Bruno.

The whole API is described in one OpenAPI 3.1 file. It includes schemas for every job, result row and error. Use it to generate a typed client in any language, or import it into your API tools.

The legacy /sold and /listings paths are marked deprecated. Use the marketplace paths instead.

Spec URL
https://soldgraph.com/openapi.json

Open openapi.json

#Generate a client

Any OpenAPI generator works. For example, typed fetch helpers for TypeScript:

TypeScript
npx openapi-typescript https://soldgraph.com/openapi.json -o soldgraph.d.ts

Or a Python client:

Python
pip install openapi-python-clientopenapi-python-client generate --url https://soldgraph.com/openapi.json

#Import into API tools

Postman, Insomnia, Bruno and Hoppscotch all import OpenAPI files. Import the URL, add your key as a bearer token, and every endpoint is ready to call.