---
title: "List user ramps"
url: https://docs.truemarkets.co/api/gateway/list-ramps
description: "Returns a paginated list of ramps for the authenticated user, newest first"
---

Docs index: https://docs.truemarkets.co/llms.txt

# List user ramps

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

## Request

```
GET https://api.truemarkets.co/v1/gateway/ramps
```

### Authentication

Bearer token in `Authorization`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `TM-On-Behalf-Of` | header | string (uuid) | no | 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. |
| `status` | query | string, one of `created`, `pending`, `completed`, `failed`, `expired` | no | Filter by ramp status |
| `cursor` | query | string | no | Opaque pagination cursor from the previous page's `next_cursor` |
| `limit` | query | integer | no | Maximum number of ramps to return |

## Responses

Every error status returns the same body, described in [Errors](https://docs.truemarkets.co/developer-resources/errors.md).

### 200

Ramps retrieved successfully

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array of object | no | List of ramps |
| `data[].id` | string (uuid) | yes |  |
| `data[].payment_method` | string, one of `COINBASE`, `PAYPAL`, `APPLE_PAY`, `GOOGLE_PAY` | yes | Rail the ramp is funded or paid out through. DeFi routes the provider from it, so it is the caller's only choice of venue. `APPLE_PAY` and `GOOGLE_PAY` are onramp-only and require a `channel`. |
| `data[].direction` | string, one of `onramp`, `offramp` | yes |  |
| `data[].status` | string, one of `created`, `pending`, `completed`, `failed`, `expired` | yes | Ramp lifecycle: `created` until funds move, `pending` while the provider settles, then `completed`, `failed`, or `expired` if it was abandoned before any funds moved. |
| `data[].amount` | string | yes | Amount requested at creation, in the settlement asset |
| `data[].chain` | string | yes | Chain the ramp settles on |
| `data[].asset_symbol` | string | no |  |
| `data[].asset_amount` | string | no | Amount actually settled |
| `data[].fiat_currency` | string | no |  |
| `data[].fiat_amount` | string | no |  |
| `data[].fee_amount` | string | no |  |
| `data[].fee_currency` | string | no |  |
| `data[].exchange_rate` | string | no |  |
| `data[].wallet_address` | string | no | Address the ramp settles against |
| `data[].provider_wallet_address` | string | no | Provider deposit address the offramp transfer sends to |
| `data[].tx_hash` | string | no |  |
| `data[].redirect_url` | string | no |  |
| `data[].failure_reason` | string | no |  |
| `data[].created_at` | string (date-time) | yes |  |
| `data[].updated_at` | string (date-time) | yes |  |
| `data[].completed_at` | string (date-time) | no |  |
| `pagination` | object | no | Cursor-based pagination metadata. The cursor is opaque and must be passed back verbatim; never parse or construct one. |
| `pagination.next_cursor` | string, nullable | no | Opaque cursor for the next page, null when the feed is exhausted |
| `pagination.limit` | integer | no | Number of items per page |

### 400

Bad request

### 401

Unauthorized

### 403

Forbidden. On order creation this also covers an asset that is not available to trade from the country the request came from.

### 500

Internal server error
