> ## Documentation Index
> Fetch the complete documentation index at: https://tetrafi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Permissions

> API-key scopes and the app permissions that grant them, for each API operation.

Each API operation below lists the API-key scopes it needs and the matching checkbox under **Permissions** when you create a key ([Authentication](https://tetrafi.mintlify.site/authentication.md#permissions)).

| Entry | Meaning |
| :- | :- |
| Two scopes in one cell | The key needs both. |
| Scopes joined by “or” | Either set is enough. |
| **None** | Any valid key may call it; it still needs authentication. |
| **Session only** | Signed-in app users only; an API key is refused. |
| **No API key required** | Called without an API key; the request carries its own credentials. |

## Scopes

| Scope | Permission in the app |
| :- | :- |
| `compliance_read` | Read compliance |
| `fee_schedule_read` | Read fee schedule |
| `orders_read` | Read orders |
| `orders_write` | Submit orders |
| `prices_read` | Read quotes |
| `quotes_read` | Read quotes |
| `quotes_request` | Read quotes + Submit orders |
| `settlements_read` | Read settlements |
| `trades_read` | Read trades |
| `treasury_read` | Treasury read |
| `webhooks_manage` | Manage webhooks |

## Auth

Exchange service-account credentials for a token, and read the credential you are calling with: its identity, scopes and rate limits.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Get current credential GET `/api/v1/me` | None | None |
| Create access token POST `/api/v1/oauth/token` | No API key required | Not applicable |

## Trading

Discover the assets, chains and venues you can trade, and read or stream their indicative prices.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List assets GET `/api/v1/assets` | `prices_read` | Read quotes |
| Get prices GET `/api/v1/prices` | `prices_read` | Read quotes |
| Stream prices GET `/api/v1/prices/stream` | `prices_read` | Read quotes |

## Quotes

Request firm or indicative quotes for an asset pair from every eligible venue, requote one, and read a quote request again.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Request quotes POST `/api/v1/quotes` | `quotes_request` | Read quotes + Submit orders |
| Get quote request GET `/api/v1/quotes/requests/{quoteRequestId}` | `quotes_read` | Read quotes |

## Orders

Place an order from a quote you hold, follow its status, and cancel it before it is sent to a venue.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List orders GET `/api/v1/orders` | `orders_read` | Read orders |
| Place order POST `/api/v1/orders` | `orders_write` | Submit orders |
| Get order by quote GET `/api/v1/orders/by-quote/{quoteId}` | `orders_read` | Read orders |
| Get order GET `/api/v1/orders/{orderId}` | `orders_read` | Read orders |
| Cancel order POST `/api/v1/orders/{orderId}/cancel` | `orders_write` | Submit orders |

## Trades

Your trade history: every order and venue trade, with its settlement and settlement obligations.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List trades GET `/api/v1/workspaces/{workspaceId}/trades` | `trades_read` | Read trades |
| Get trade GET `/api/v1/workspaces/{workspaceId}/trades/{tradeId}` | `trades_read` | Read trades |
| Get trade settlement GET `/api/v1/workspaces/{workspaceId}/trades/{tradeId}/settlement` | `settlements_read` | Read settlements |
| List trade obligations GET `/api/v1/workspaces/{workspaceId}/trades/{tradeId}/settlement/obligations` | `settlements_read` | Read settlements |

## Settlements

Your venue accounts' settlement windows, obligations, movements and schedules, and the plan of what is due across them.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Get settlement plan GET `/api/v1/workspaces/{workspaceId}/settlement/plan` | `settlements_read` | Read settlements |
| List account movements GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/movements` | `settlements_read` | Read settlements |
| Get account movement GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/movements/{movementId}` | `settlements_read` | Read settlements |
| List account obligations GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/obligations` | `settlements_read` | Read settlements |
| Get account obligation GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/obligations/{obligationId}` | `settlements_read` | Read settlements |
| Get account schedules GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/schedules` | `settlements_read` | Read settlements |
| List account windows GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows` | `settlements_read` | Read settlements |
| Get account window GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows/{windowId}` | `settlements_read` | Read settlements |
| List account window matches GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/settlement/windows/{windowId}/matches` | `settlements_read` | Read settlements |

## Treasury

Balances across the workspace's wallets and venue accounts.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List workspace balances GET `/api/v1/workspaces/{workspaceId}/balances` | `treasury_read` | Treasury read |

## Venue accounts

One venue account's balances, deposit instructions and history, credit and ledger.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Get account balances GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/balances` | `treasury_read` | Treasury read |
| Get account credit GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/credit` | `treasury_read` | Treasury read |
| List account deposits GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/deposit-history` | `treasury_read` | Treasury read |
| Get deposit instructions GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/deposit-instructions` | `treasury_read` | Treasury read |
| Get account ledger GET `/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/ledger` | `treasury_read` | Treasury read |

## Venue enablements

The workspace's venue accounts, with where their funds are held and each venue's key state.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List venue accounts GET `/api/v1/workspaces/{workspaceId}/venue-enablements` | `treasury_read` | Treasury read |

## Webhooks

Register endpoints for signed event deliveries, rotate their secrets, send test deliveries and read the delivery log.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| List webhooks GET `/api/v1/workspaces/{workspaceId}/webhooks` | `webhooks_manage` | Manage webhooks |
| Create webhook POST `/api/v1/workspaces/{workspaceId}/webhooks` | `webhooks_manage` | Manage webhooks |
| Delete webhook DELETE `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}` | `webhooks_manage` | Manage webhooks |
| Get webhook GET `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}` | `webhooks_manage` | Manage webhooks |
| Update webhook PATCH `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}` | `webhooks_manage` | Manage webhooks |
| List deliveries GET `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries` | `webhooks_manage` | Manage webhooks |
| Send test delivery POST `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries` | `webhooks_manage` | Manage webhooks |
| Retry delivery POST `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry` | `webhooks_manage` | Manage webhooks |
| Resume webhook POST `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/resume` | `webhooks_manage` | Manage webhooks |
| Rotate webhook secret POST `/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/rotate` | `webhooks_manage` | Manage webhooks |

## Workspaces

The workspace's verification state, the capabilities it allows, and its fee schedule.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Get capabilities GET `/api/v1/workspaces/{workspaceId}/capabilities` | `compliance_read` | Read compliance |
| Get fee schedule GET `/api/v1/workspaces/{workspaceId}/fee-schedule` | `fee_schedule_read` | Read fee schedule |

## Batch

Read up to 20 resources in one request, each answered exactly as its own GET.

| Operation | API-key scopes | Permission in the app |
| :- | :- | :- |
| Batch reads POST `/api/v1/batch` | None | None |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.