Skip to main content
The Sharpe API uses URL-path versioning (/v1/). Additions ship at any time; a breaking change ships on a stated day, announced in the changelog with a migration note.

Current version

The current and only production version is v1, accessible at https://www.sharpe.ai/api/v1/.

Backward-compatible changes

The following changes are considered backward-compatible and may be made without a version bump or advance notice:
  • Adding new endpoints
  • Adding new optional query parameters to existing endpoints
  • Adding new fields to response objects
  • Adding new error codes
  • Adding new enum values to non-strict parameters
  • Improving error messages for clarity
Your integration should handle unknown response fields gracefully (ignore fields you don’t recognize).

Breaking changes

The following changes are considered breaking:
  • Removing or renaming existing endpoints
  • Removing or renaming response fields
  • Changing the type or the unit of an existing response field
  • Making an optional parameter required
  • Changing authentication requirements
  • Changing the response envelope structure
A breaking change ships on the day its changelog entry names, with a migration note saying what to change. The old shape is not served beside the new one. A field never keeps its name when its meaning or its unit changes, so code written for the old shape fails on a missing field instead of reading a wrong number.

Exception: discontinued upstream sources

When the upstream source behind an endpoint is discontinued, the endpoint can be removed without the notice window. From the day it is removed, it answers 410 Gone with a problem+json body that links to the changelog entry recording the removal. The endpoints removed on 2026-09-23 were removed before this rule and answer 404.
Query-string API keys are rejected by default. Use Authorization: Bearer or X-API-Key headers for all production integrations. See Authentication for the supported request shape.

Monitoring for changes

  • Changelog: /docs/changelog lists changes from 2026-09-23 on, each with its date, kind and affected endpoints. The RSS feed carries the same entries
  • Response headers: A request that uses a deprecated shape (today, the api_key query parameter, where it is still accepted) is answered with a Deprecation header naming the replacement

Migration: percent fields became fractions (2026-11-14)

Every /v1 field that was served in percent (5.4 for 5.4%) is a fraction (0.054) under a new name, and the fields whose name said “percent” while holding a fraction lost the word. The scanners’ minApr (percentage points) is minNet, a fraction; a request that still sends minApr gets 400 invalid_parameter. To move: read each field under its new name and multiply any value you stored before by the factor below. The names follow one rule: the unit word goes (basisPct → basis), price and market-cap moves are returns (change24h → return24h), shares say share (btcDominance → btcMarketShare), the distance from the all-time high or low is fromAth / fromAtl, and a field that only repeated another is removed. Paths are inside each answer’s data.