Two services, one endpoint at , over gRPC, gRPC-web, and JSON at . The protobuf definition at is the contract; these pages describe it. Every method has a playground. The three quote methods have theirs inline on this reference; the rest are under Try it in the sidebar. Send runs against mainnet — see Transports.

Services

apsis.v1.ApsisApi

Public. Quoting, catalog, chains, and order state. Optional API key.

apsis.v1.PartnerApi

Partner-scoped. Sign-in, API keys, referral claims. Requires a session.

Methods

Headers

Conventions

Field names are snake_case on the wire. Generated clients usually expose them as camelCase; both appear in these docs, matching whichever surface the example uses. Amounts are strings because they overflow a JSON number. Parse to a big integer, never a float.

Status codes

See Error handling for the messages behind each code.

Pagination

Listing methods take limit and cursor and return next_cursor. An absent next_cursor means the last page. Cursors are opaque base64 and must not be constructed by hand.

No streaming

Every method is unary. There is no server stream, webhook, or subscription; track orders by polling GetOrder. See Track an order.

JSON transcoding

The JSON transport maps each method to a REST route under {API_JSON_URL}/v1/: read methods are GETs whose request fields become query or path parameters, mutating methods are POSTs with the request message as the body, and key revocation is a DELETE. Each method’s route is shown on its reference page. Field names stay as the proto defines them, 64-bit integers are decimal strings, and bytes fields are base64. A non-OK status becomes an HTTP error with the gRPC code in the body:
Codes follow the gRPC status list: 3 is INVALID_ARGUMENT, 5 NOT_FOUND, 8 RESOURCE_EXHAUSTED, 14 UNAVAILABLE, 16 UNAUTHENTICATED.