Skip to content

API Reference

Authentication, endpoints and request examples.

Authentication

Every request authenticates with an API key, sent in the Authorization header as a bearer token:

Header
Authorization: Bearer <your-api-key>

Create keys in the app under Workspace settings, API keys. Give each key only the policies it needs. The full key is shown once, so store it somewhere safe. If you lose it, delete it and create a new one.

Base URL

URL
https://api.goldmine.to

Every endpoint is a POST with a JSON body, at the path of the procedure it calls. Failures return a JSON body with a string code and a readable message. Lists return one page and a nextCursor. 64-bit integers, such as prices in cents, are strings in JSON. Ids and other byte fields are base64 strings in JSON, as in the examples.

Machine-readable spec

The full OpenAPI specification is published at goldmine.to/openapi.json. Point a code generator such as oapi-codegen (Go) or openapi-generator at it to get a typed client.

Using these docs with AI tools

Every page has a Copy Markdown button and a plain Markdown version, and llms.txt lists every page, so an assistant can read the reference directly.

All endpoints