For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/gateway/list-ramps.md.

List user ramps

Organization tokenNo token

GET
/ramps

Returns a paginated list of ramps for the authenticated user, newest first

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

An access token from POST /v1/auth/api-key/token. An organization token lasts one hour and has no refresh token; a personal token can be refreshed.

Query Parameters

status?string

Filter by ramp status

Value in"created""pending""completed""failed""expired"
cursor?string

Opaque pagination cursor from the previous page's next_cursor

limit?integer

Maximum number of ramps to return

Range1 <= value <= 100
Default50

Header Parameters

TM-On-Behalf-Of?string

Act as one of your organization's users. The value is the user_id returned when the user was created; the request then reads and writes that user's account. Requires an organization token and a user your organization created: 400 for a personal token, a repeated header or a non-UUID, 403 for a user outside your organization. Not accepted on organization-scoped routes.

Formatuuid

Response Body

Ramps retrieved successfully

application/json
  1. response

Paginated list of ramps

data?array<>

List of ramps

pagination?

Cursor-based pagination metadata. The cursor is opaque and must be passed back verbatim; never parse or construct one.

Example Request
curl -X GET 'https://api.truemarkets.co/v1/gateway/ramps' \  -H 'TM-On-Behalf-Of: 3f6d2c0e-8a41-4c2b-9f1e-2b7d5c0a9e11'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "payment_method": "COINBASE",      "direction": "onramp",      "status": "created",      "amount": "string",      "chain": "solana",      "asset_symbol": "string",      "asset_amount": "string",      "fiat_currency": "string",      "fiat_amount": "string",      "fee_amount": "string",      "fee_currency": "string",      "exchange_rate": "string",      "wallet_address": "string",      "provider_wallet_address": "string",      "tx_hash": "string",      "redirect_url": "string",      "failure_reason": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "next_cursor": "string",    "limit": 0  }}