Developer Tools

Official SDKs, testing tools, machine-readable specs, and AI integrations for the Sharpe API.

Official SDKs

Auto-generated from the OpenAPI specification. Registry packages are published from generated output when API contract releases ship.

Both SDKs follow the standard OpenAPI Generator pattern: a shared Configuration object plus per-category API classes (AccountApi, ArbitrageApi, CategoriesApi, DerivativesApi, MarketDataApi, NewListingsApi, ScreenerApi, SignalsApi, SystemApi).

Python

pip install sharpe-terminal-api

from sharpe_terminal_api import ApiClient, Configuration, DerivativesApi

config = Configuration(
    host="https://www.sharpe.ai/api",
    api_key={"ApiKeyAuth": "sk_live_your_key_here"},
)

with ApiClient(config) as client:
    derivatives = DerivativesApi(client)
    rates = derivatives.get_funding_rates(type="current")
    for row in rates.data:
        print(f"{row.exchange} {row.symbol}: {row.rate}")

TypeScript

npm install @sharpe-terminal/api

import { Configuration, DerivativesApi } from '@sharpe-terminal/api'

const config = new Configuration({
  basePath: 'https://www.sharpe.ai/api',
  headers: { Authorization: 'Bearer sk_live_your_key_here' },
})

const api = new DerivativesApi(config)
const rates = await api.getFundingRates({ type: 'current' })
rates.data.forEach((r) => console.log(`${r.exchange} ${r.symbol}: ${r.rate}`))

Postman Collection

Import the Postman collection to explore every endpoint interactively. All requests are pre-configured with variables for your API key and base URL.

1. Download sharpe-api.postman_collection.json
2. Open Postman and click Import
3. Set the api_key collection variable to a key from the API key dashboard
4. Send any request

API Playground

The interactive API playground lets you explore every endpoint, fill in parameters, send live requests, and see responses — all from your browser. Code snippets are auto-generated in 25+ languages.

• Free endpoints work without authentication — try them instantly
• Authenticated endpoints require your API key (paste it in the auth panel)
• Code generation in Python, TypeScript, cURL, Go, PHP, Ruby, Java, and more

Health check

Returns API health status and backing-service checks. This endpoint does not require an API key and returns 200 when healthy or 503 when degraded.

curl https://www.sharpe.ai/api/v1/health

Coverage metadata

Returns product-surface coverage metadata for Sharpe Terminal: UI routes, public API routes, authenticated API routes, docs routes, OpenAPI paths, MCP tools, CLI commands, data sources, freshness SLAs, and test coverage. This endpoint does not require an API key.

curl https://www.sharpe.ai/api/v1/meta/coverage

OpenAPI Specification

The full API is described in an OpenAPI 3.0 document. Use it with code generators, API clients, or documentation tools.

curl -O https://www.sharpe.ai/openapi.json

Generate a client

npx openapi-typescript https://www.sharpe.ai/openapi.json -o sharpe-api.d.ts

openapi-python-client generate --url https://www.sharpe.ai/openapi.json

The spec is also available at /openapi.json on the docs site.

MCP Server

The Sharpe MCP server gives AI agents (Claude, Cursor, and any MCP client) direct access to crypto market data through 41 tools (38 endpoint tools plus 3 composite workflows), 4 resources, and 2 guided prompts. No install needed: uvx --from sharpe-terminal-mcp sharpe-mcp always runs the latest version.

CLI Tool

The Sharpe CLI provides 32 commands for accessing market data from your terminal. Colored tables, JSON output, live watch mode, and a daily briefing command. Run uvx --from sharpe-terminal-mcp sharpe market to try it instantly.

llms.txt

The API documentation is available in a plain-text format optimized for LLM consumption at /llms-full.txt. The shorter /llms.txt file is the site-wide agent summary; the full file includes every endpoint, parameter, and response shape in a single reference.

curl https://www.sharpe.ai/llms-full.txt

Authentication reminder

Use header-based authentication in generated clients and API tools: Authorization: Bearer is recommended, and X-API-Key is also supported. Query-string API keys are rejected by default because URLs are commonly stored in logs, browser history, analytics tools, and referrer headers. See the authentication guide for details.