Agora Public APIEndpointsRoutes

Get a Route by ID

Beta
<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout> Retrieve a single route by its id, including the full reusable `instructions` block. Route ids are deterministic — the same canonical inputs always derive the same id — so a `404` means no route with those parameters has been created for your organization.

Authentication

AuthorizationBearer

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

Path parameters

routeIdstringRequiredformat: "uuid"

Response

OK
idstringformat: "uuid"

Deterministic route UUID — same canonical inputs always derive the same id.

createdAtdatetime
fromobject
toobject
instructionslist of objects

Next-step instructions. Mint-fiat: one wire instruction with memo + beneficiary. On-chain directions: one deposit address per supported chain, alphabetical by chain.

namestring or null

User-set label, or null when unset.

Errors

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