Public API docs

Ratevert API Docs

Ratevert publishes a read-only API surface for asset search, exact pair quotes, multi-asset comparisons, markdown negotiation, OAuth discovery, and agent discovery.

API catalog

RFC 9727 linkset for automated API discovery.

https://ratevert.com/.well-known/api-catalog

OpenAPI

OpenAPI 3.1 description for the public read-only API surface.

https://ratevert.com/openapi.json

OIDC discovery

OpenID Connect discovery metadata for the Clerk-backed Ratevert auth server.

https://ratevert.com/.well-known/openid-configuration

OAuth discovery

OAuth 2.0 authorization server metadata for programmatic client auth discovery.

https://ratevert.com/.well-known/oauth-authorization-server

Protected resource

OAuth protected resource metadata describing how to authenticate against Ratevert.

https://ratevert.com/.well-known/oauth-protected-resource

Agent skills index

Agent Skills discovery index for Ratevert task-specific skills.

https://ratevert.com/.well-known/agent-skills/index.json

MCP discovery

MCP discovery document for remote MCP clients.

https://ratevert.com/.well-known/mcp.json

API status

Machine-readable health information for the public API.

https://ratevert.com/api/status

Overview

What the public API covers

The public API is read-only. It is designed to help agents and client applications resolve canonical assets, fetch live pair quotes, compare markets, discover authentication metadata, and find related agent-facing resources.

search_assets

Search canonical Ratevert assets

Search the public Ratevert catalog for canonical currency, stock, ETF, fund, crypto, and fiat assets before opening a pair or comparison.

Endpoint

https://ratevert.com/api/search

Example

curl "https://ratevert.com/api/search?q=btc&market=crypto&page=1&pageSize=5"

Query parameters

q (optional): Optional partial code, ticker, currency code, or asset name. When omitted, the endpoint returns top assets.

market (optional): Optional market filter. Supported values are all, fiat (currency), stocks, ETFs, funds, and crypto.

page (optional): Optional 1-based page number.

pageSize (optional): Optional page size capped at 100 results.

Response: Paginated JSON results with canonical asset slugs, labels, markets, and default Ratevert links.

get_rate

Fetch a live Ratevert pair quote

Resolve one exact pair and return the live one-unit conversion rate together with the canonical Ratevert URL.

Endpoint

https://ratevert.com/api/rate

Example

curl "https://ratevert.com/api/rate?base=nvda&quote=usd"

Query parameters

base (required): Required base asset identifier such as btc, nvda, usd, or an alternate alias.

quote (required): Required quote asset identifier such as usd, eur, or jpy.

Response: JSON containing normalized base and quote assets, the live rate, and the canonical Ratevert pair URL.

compare_assets

Compare one asset against several targets

Compare one source asset against multiple targets in the public website API using repeated target query parameters.

Endpoint

https://ratevert.com/api/compare

Example

curl "https://ratevert.com/api/compare?source=btc&target=usd&target=eur&target=nvda"

Query parameters

source (required): Required source asset identifier.

target (required): Required repeated target asset identifiers. Use one target query parameter for each comparison asset.

Response: JSON with the canonical source asset, the comparison list, total asset count, and canonical Ratevert URLs.

Markdown for agents

Request public pages as markdown

Send Accept: text/markdown to any supported public Ratevert page to receive a markdown representation. Browsers still receive HTML by default.

curl "https://ratevert.com" -H "Accept: text/markdown"

Authenticated API access

Discover Ratevert auth metadata

Ratevert publishes OAuth and OpenID Connect metadata for the Clerk-backed auth server, plus protected resource metadata describing how agents can authenticate against Ratevert's protected API surfaces.

curl "https://ratevert.com/.well-known/openid-configuration"

curl "https://ratevert.com/.well-known/oauth-authorization-server"

curl "https://ratevert.com/.well-known/oauth-protected-resource"