Interactive reference for the Goldmine API. All endpoints use ConnectRPC over HTTP with JSON request/response bodies via POST.

Authentication

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

Authorization: Bearer <your-api-key>

Getting an API key

API keys are created from the dashboard, not through this API:

1. Sign in to the Goldmine dashboard and select the workspace the key should belong to. Each key is scoped to a single workspace.
2. Open API Keys from the workspace settings.
3. Choose Create API key, give it a name, and select the policies that decide what the key is allowed to do. A key only ever carries the policies you grant it, so scope it to just what your integration needs.
4. Confirm with your account password, and a two-factor code if you have two-factor enabled. You can optionally set an expiry.
5. Copy the key when it is shown. The full key is displayed once and cannot be retrieved again, so store it somewhere safe. If you lose it, delete the key and create a new one.

Treat an API key like a password: it acts on behalf of your workspace within the policies it holds, and you can revoke it at any time from the same API Keys page.

Base URL

https://api.goldmine.to

Machine-readable spec

The full OpenAPI specification is published at https://goldmine.to/openapi.json. Point a code generator such as oapi-codegen (Go) or openapi-generator (most languages) at that URL to generate a typed client.

Using these docs with AI tools

Every page of this documentation is published in a form built for large language models. https://goldmine.to/llms.txt is an index of every endpoint that follows the llms.txt convention, and any page is available as plain Markdown by requesting it under the llms.mdx path, for example https://goldmine.to/llms.mdx/contracts/contracts.v1.Contracts.GetPnLBreakdown. Give an AI assistant the llms.txt index or the openapi.json spec and it can read the whole API and call it on your behalf.

Endpoints

Browse the sidebar to explore available endpoints grouped by resource type.