Agora Public APIEndpointsRoutes

List Routes

Return every route on the authenticated organization. Each route includes the full `instructions` block so callers can resolve memos and mint/redeem addresses without an additional retrieve. Narrow the list with `fromCurrency`, `toCurrency`, `toChain`, and `toAccountId`; every filter you send must hold (see [Filtering list endpoints](/api#filtering-list-endpoints)). `toChain` matches on-chain destinations only, so a redeem-to-fiat route never matches it.

Authentication

AuthorizationBearer

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Query parameters

cursorstringOptional

Opaque pagination cursor. Pass the nextCursor from the previous response; omit to fetch the first page.

limitintegerOptional1-200Defaults to 50

Page size. Defaults to 50; capped at 200.

fromCurrencyenumOptional

Return only routes with this source currency. The stablecoin wildcard matches routes stored against the wildcard; it does not expand to the individual stablecoins it covers.

Allowed values:
toAccountIdstringOptionalformat: "uuid"

Return only routes pointing at this registered account. A well-formed id belonging to another organization, or to nothing, returns an empty page rather than an error.

toChainlist of enumsOptional

Return only routes landing on any of these chains, comma-separated. Fiat and wire destinations carry no chain and are never matched by this filter.

toCurrencyenumOptional
Return only routes with this destination currency.
Allowed values:

Response

OK
datalist of objects

Page of routes, newest first, tie-broken by id.

nextCursorstring or null

Opaque cursor for the next page. Pass back verbatim as the cursor query param to fetch the next page; null when no more results.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error