Developer Platform

Developer Portal

Build against Gold Shore APIs with predictable auth, typed payloads, and quick paths to production.

Read full docs · OpenAPI endpoint reference

API model

API model overview

Gold Shore APIs follow a resource-oriented model with JSON request and response payloads, deterministic status codes, and stable versioning under /v1.

Format: JSON over HTTPS
Versioning: path versioned (/v1/*)
Errors: structured error envelope with trace context

API model guide

Authentication

Auth summary

Gold Shore endpoints expect a bearer token on every request. In production, use your Cloudflare Access / service-issued JWT. For local prototyping, start with a temporary sandbox token.

Header: Authorization: Bearer <token>
Audience: configured for Gold Shore service access
Rotation: short-lived tokens recommended

Auth docs

Endpoints

Endpoint grouping

API paths are grouped to keep integrations easy to navigate:

System: health, version, metadata.
Portfolio: balances and positions.
Orders: create, list, and cancel orders.
Webhooks: outbound event delivery.

Endpoint guide

OpenAPI

Specification path and embedded docs

Use the generated OpenAPI-driven reference at /developer/api for schema and endpoint details. Start directly at /developer/api/system/info for connectivity checks.

Open API reference · Open system info endpoint docs

Code examples

Copy any snippet and run against your environment.

cURL: fetch positions

curl -X GET "/v1/portfolio/positions" \
  -H "Authorization: Bearer demo_test_token_replace_me" \
  -H "Content-Type: application/json"

TypeScript: create order

const response = await fetch('/v1/orders', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer demo_test_token_replace_me',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    symbol: 'BTC-USD',
    side: 'buy',
    quantity: 0.25,
    type: 'market',
  }),
});

const data = await response.json();
console.log(data);

Python: inspect system info

import requests

resp = requests.get(
    '/v1/system/info',
    headers={'Authorization': 'Bearer demo_test_token_replace_me'},
    timeout=10,
)
print(resp.status_code)
print(resp.json())