API reference

Base URL:

https://meadow.example.com

Auth: the api-key header on quote, settlement, order, position, and earnings endpoints — see Get API access. The four discovery endpoints (chains, assets, venues, rates) are public.

The envelope

Meadow shares Photon's envelope:

{ "success": true, "data": …, "timestamp": "2026-07-29T12:00:00.000Z" }

Errors:

{
  "success": false,
  "error": { "code": "RESOURCE_001", "message": "quote expired",
             "category": "RESOURCE", "traceId": "…" },
  "timestamp": "2026-07-29T12:00:00.000Z"
}

Codes come from the shared error table.

Conventions

• Amounts and shares are base-10 integer strings in smallest units.
• APYs are numbers: netApy/grossApy in percent, apyBps/feeBps/ minApyBps/shareBps in basis points.
• expiresAt on quotes is Unix seconds.
• Ids (quoteId, orderId) are 24-hex-character strings.
• Request bodies are camelCase; the one exception is Get rates's risk_tier query parameter.
• Order status is relaying → confirmed | failed; order kind distinguishes deposits from withdrawals.

Endpoints

Each page renders the full schema from the OpenAPI spec and is interactive against your deployment.

Endpoint	Purpose
List chains · List assets · List venues · Get rates	Discovery (public).
Request a quote	Run the auction for an intent.
Get a quote	Re-fetch a quote by id.
Create a deposit	Settle a signed plan (deposits and withdrawal plans).
Create a withdrawal	Build an exit plan to sign.
Get an order	Settlement status, photonTxId, executionTxHash.
List positions · Get earnings	Live holdings and profit vs cost basis.