For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /metadata

API version and network metadata

API version and network metadata.

operationId: fetchApiVersionMetadata

Declared server: https://api.testnet.nexus.xyz/v1. See Networks.

Not reachable through CCXT. Transport-level version negotiation for this venue's own API. CCXT has no method for it and handles client compatibility in its own adapter layer.

Authentication: none. This endpoint is public.

API version and network metadata

get
/metadata

Programmatic API-version and exchange-network discovery. Unauthenticated and exempt from the version gate itself, so a client that has just been rejected with 426 api_version_unsupported can always reach the value it needs to self-heal — read api_version.min_supported, regenerate against spec_url, and retry with the X-Nexus-Api-Version header (ENG-5365). network comes directly from the instance's required auth.network runtime configuration; it is not inferred from deploy tier, hostname, or wallet state.

Static per deployment: the body is rendered once at boot from the instance's [api_version] and [auth] configuration and served unchanged, so it reflects the running build rather than live state.

Versions here are bare MAJOR.MINOR.PATCH with no v prefix, unlike the released spec tags. Root mount only — the edge does not serve an /api/v1/metadata sibling.

This is not the shape described by the unreferenced Metadata schema in this contract; see that schema's own description.

Responses
200

The version window this deployment serves.

application/json

Body of GET /metadata: the exchange network declared by required runtime configuration and the API version window this deployment accepts. Rendered once at boot, so every field is always present — an unset deprecated_below or sunset is serialized as null rather than omitted.

Version strings are bare MAJOR.MINOR.PATCH. They are not the v-prefixed released spec tags, so compare them after stripping any prefix of your own.

networkstring · max: 32Required

Exchange network declared by the instance's required auth.network runtime configuration. Known values are mainnet, testnet, and local; clients must tolerate future values. This value is not inferred from deployment environment, hostname, or wallet state.

Example: testnet
get/metadata
GET /v1/metadata HTTP/1.1
Host: api.testnet.nexus.xyz
Accept: */*
200

The version window this deployment serves.

{
  "network": "testnet",
  "api_version": {
    "header": "x-nexus-api-version",
    "min_supported": "0.0.0",
    "current": "0.9.69",
    "deprecated_below": null,
    "sunset": null,
    "spec_url": "https://github.com/nexus-xyz/nexus-exchange-api/releases",
    "docs_url": "https://docs.nexus.xyz/exchange/apis-and-rates/api-versioning",
    "policy": "pre-1.0: minimum-supported version may advance until GA; missing version header allowed during grace mode"
  }
}

API version 0.9.131

Last updated