> ## 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.

# Endpoints at a glance

> All 45 API operations by task, with the scopes each needs and the guide that walks through it.

Paths are relative to the [base URL](https://tetrafi.mintlify.site/reference/conventions.md#requests); `…` stands for `/api/v1/workspaces/{workspaceId}`. Click an endpoint for its parameters, responses and a request you can try; [Permissions](https://tetrafi.mintlify.site/reference/permissions.md) explains the scopes.

> [card] [Authentication](#authentication)
>
> 2 endpoints. Check the credential you call with, or exchange service-account credentials for a token.

> [card] [Assets and prices](#assets-and-prices)
>
> 3 endpoints. Discover what you can trade and read indicative prices before you ask for a quote.

> [card] [Quotes](#quotes)
>
> 2 endpoints. Ask every venue your workspace can use for a quote in one request, and read a request back.

> [card] [Orders](#orders)
>
> 5 endpoints. Order a quote by its id, follow the order, recover it by quote and cancel it.

> [card] [Trades and settlement](#trades-and-settlement)
>
> 13 endpoints. Read your trades, how each settles, and the settlement plan, windows and movements per venue account.

> [card] [Balances and accounts](#balances-and-accounts)
>
> 9 endpoints. Read balances, venue accounts and their credit, deposits and ledger, your fee schedule and what your workspace can do.

> [card] [Webhooks](#webhooks)
>
> 10 endpoints. Receive order and settlement updates by webhook, and manage endpoints, deliveries and secrets.

> [card] [Batch](#batch)
>
> 1 endpoint. Run up to 20 reads in one request.

## Authentication

Check the credential you call with, or exchange service-account credentials for a token. Guide: [Authentication](https://tetrafi.mintlify.site/authentication.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [Get current credential](https://tetrafi.mintlify.site/api-reference/auth/get-current-credential.md) | GET `/api/v1/me` | None |
| [Create access token](https://tetrafi.mintlify.site/api-reference/auth/create-access-token.md) | POST `/api/v1/oauth/token` | No API key required |

## Assets and prices

Discover what you can trade and read indicative prices before you ask for a quote. Guide: [Assets and prices](https://tetrafi.mintlify.site/search/prices.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [List assets](https://tetrafi.mintlify.site/api-reference/trading/list-assets.md) · [guide](https://tetrafi.mintlify.site/search/how-it-works.md) | GET `/api/v1/assets` | `prices_read` |
| [Get prices](https://tetrafi.mintlify.site/api-reference/trading/get-prices.md) | GET `/api/v1/prices` | `prices_read` |
| [Stream prices](https://tetrafi.mintlify.site/api-reference/trading/stream-prices.md) | GET `/api/v1/prices/stream` | `prices_read` |

## Quotes

Ask every venue your workspace can use for a quote in one request, and read a request back. Guide: [Quotes](https://tetrafi.mintlify.site/search/how-it-works.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [Request quotes](https://tetrafi.mintlify.site/api-reference/quotes/request-quotes.md) | POST `/api/v1/quotes` | `quotes_request` |
| [Get quote request](https://tetrafi.mintlify.site/api-reference/quotes/get-quote-request.md) · [guide](https://tetrafi.mintlify.site/search/how-it-works.md) | GET `/api/v1/quotes/requests/{quoteRequestId}` | `quotes_read` |

## Orders

Order a quote by its id, follow the order, recover it by quote and cancel it. Guide: [Orders](https://tetrafi.mintlify.site/trade/orders.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [List orders](https://tetrafi.mintlify.site/api-reference/orders/list-orders.md) · [guide](https://tetrafi.mintlify.site/trade/order-status.md) | GET `/api/v1/orders` | `orders_read` |
| [Place order](https://tetrafi.mintlify.site/api-reference/orders/place-order.md) | POST `/api/v1/orders` | `orders_write` |
| [Get order by quote](https://tetrafi.mintlify.site/api-reference/orders/get-order-by-quote.md) | GET `/api/v1/orders/by-quote/{quoteId}` | `orders_read` |
| [Get order](https://tetrafi.mintlify.site/api-reference/orders/get-order.md) · [guide](https://tetrafi.mintlify.site/trade/order-status.md) | GET `/api/v1/orders/{orderId}` | `orders_read` |
| [Cancel order](https://tetrafi.mintlify.site/api-reference/orders/cancel-order.md) | POST `/api/v1/orders/{orderId}/cancel` | `orders_write` |

## Trades and settlement

Read your trades, how each settles, and the settlement plan, windows and movements per venue account. Guide: [Trades and settlement](https://tetrafi.mintlify.site/trade/settlement-and-credit.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [List trades](https://tetrafi.mintlify.site/api-reference/trades/list-trades.md) | GET `…/trades` | `trades_read` |
| [Get trade](https://tetrafi.mintlify.site/api-reference/trades/get-trade.md) | GET `…/trades/{tradeId}` | `trades_read` |
| [Get trade settlement](https://tetrafi.mintlify.site/api-reference/trades/get-trade-settlement.md) | GET `…/trades/{tradeId}/settlement` | `settlements_read` |
| [List trade obligations](https://tetrafi.mintlify.site/api-reference/trades/list-trade-obligations.md) | GET `…/trades/{tradeId}/settlement/obligations` | `settlements_read` |
| [Get settlement plan](https://tetrafi.mintlify.site/api-reference/settlements/get-settlement-plan.md) | GET `…/settlement/plan` | `settlements_read` |
| [List account movements](https://tetrafi.mintlify.site/api-reference/settlements/list-account-movements.md) | GET `…/venue-accounts/{venueAccountId}/settlement/movements` | `settlements_read` |
| [Get account movement](https://tetrafi.mintlify.site/api-reference/settlements/get-account-movement.md) | GET `…/venue-accounts/{venueAccountId}/settlement/movements/{movementId}` | `settlements_read` |
| [List account obligations](https://tetrafi.mintlify.site/api-reference/settlements/list-account-obligations.md) | GET `…/venue-accounts/{venueAccountId}/settlement/obligations` | `settlements_read` |
| [Get account obligation](https://tetrafi.mintlify.site/api-reference/settlements/get-account-obligation.md) | GET `…/venue-accounts/{venueAccountId}/settlement/obligations/{obligationId}` | `settlements_read` |
| [Get account schedules](https://tetrafi.mintlify.site/api-reference/settlements/get-account-schedules.md) | GET `…/venue-accounts/{venueAccountId}/settlement/schedules` | `settlements_read` |
| [List account windows](https://tetrafi.mintlify.site/api-reference/settlements/list-account-windows.md) | GET `…/venue-accounts/{venueAccountId}/settlement/windows` | `settlements_read` |
| [Get account window](https://tetrafi.mintlify.site/api-reference/settlements/get-account-window.md) | GET `…/venue-accounts/{venueAccountId}/settlement/windows/{windowId}` | `settlements_read` |
| [List account window matches](https://tetrafi.mintlify.site/api-reference/settlements/list-account-window-matches.md) | GET `…/venue-accounts/{venueAccountId}/settlement/windows/{windowId}/matches` | `settlements_read` |

## Balances and accounts

Read balances, venue accounts and their credit, deposits and ledger, your fee schedule and what your workspace can do. Guide: [Balances and accounts](https://tetrafi.mintlify.site/trade/balances.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [List workspace balances](https://tetrafi.mintlify.site/api-reference/treasury/list-workspace-balances.md) | GET `…/balances` | `treasury_read` |
| [Get account balances](https://tetrafi.mintlify.site/api-reference/venue-accounts/get-account-balances.md) | GET `…/venue-accounts/{venueAccountId}/balances` | `treasury_read` |
| [Get account credit](https://tetrafi.mintlify.site/api-reference/venue-accounts/get-account-credit.md) | GET `…/venue-accounts/{venueAccountId}/credit` | `treasury_read` |
| [List account deposits](https://tetrafi.mintlify.site/api-reference/venue-accounts/list-account-deposits.md) | GET `…/venue-accounts/{venueAccountId}/deposit-history` | `treasury_read` |
| [Get deposit instructions](https://tetrafi.mintlify.site/api-reference/venue-accounts/get-deposit-instructions.md) | GET `…/venue-accounts/{venueAccountId}/deposit-instructions` | `treasury_read` |
| [Get account ledger](https://tetrafi.mintlify.site/api-reference/venue-accounts/get-account-ledger.md) | GET `…/venue-accounts/{venueAccountId}/ledger` | `treasury_read` |
| [List venue accounts](https://tetrafi.mintlify.site/api-reference/venue-enablements/list-venue-accounts.md) · [guide](https://tetrafi.mintlify.site/trade/wallets-and-accounts.md) | GET `…/venue-enablements` | `treasury_read` |
| [Get capabilities](https://tetrafi.mintlify.site/api-reference/workspaces/get-capabilities.md) · [guide](https://tetrafi.mintlify.site/before-you-trade.md) | GET `…/capabilities` | `compliance_read` |
| [Get fee schedule](https://tetrafi.mintlify.site/api-reference/workspaces/get-fee-schedule.md) | GET `…/fee-schedule` | `fee_schedule_read` |

## Webhooks

Receive order and settlement updates by webhook, and manage endpoints, deliveries and secrets. Guide: [Webhooks](https://tetrafi.mintlify.site/trade/webhooks.md).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [List webhooks](https://tetrafi.mintlify.site/api-reference/webhooks/list-webhooks.md) | GET `…/webhooks` | `webhooks_manage` |
| [Create webhook](https://tetrafi.mintlify.site/api-reference/webhooks/create-webhook.md) | POST `…/webhooks` | `webhooks_manage` |
| [Get webhook](https://tetrafi.mintlify.site/api-reference/webhooks/get-webhook.md) | GET `…/webhooks/{webhookId}` | `webhooks_manage` |
| [Update webhook](https://tetrafi.mintlify.site/api-reference/webhooks/update-webhook.md) | PATCH `…/webhooks/{webhookId}` | `webhooks_manage` |
| [Delete webhook](https://tetrafi.mintlify.site/api-reference/webhooks/delete-webhook.md) | DELETE `…/webhooks/{webhookId}` | `webhooks_manage` |
| [List deliveries](https://tetrafi.mintlify.site/api-reference/webhooks/list-deliveries.md) | GET `…/webhooks/{webhookId}/deliveries` | `webhooks_manage` |
| [Send test delivery](https://tetrafi.mintlify.site/api-reference/webhooks/send-test-delivery.md) | POST `…/webhooks/{webhookId}/deliveries` | `webhooks_manage` |
| [Retry delivery](https://tetrafi.mintlify.site/api-reference/webhooks/retry-delivery.md) | POST `…/webhooks/{webhookId}/deliveries/{deliveryId}/retry` | `webhooks_manage` |
| [Resume webhook](https://tetrafi.mintlify.site/api-reference/webhooks/resume-webhook.md) | POST `…/webhooks/{webhookId}/resume` | `webhooks_manage` |
| [Rotate webhook secret](https://tetrafi.mintlify.site/api-reference/webhooks/rotate-webhook-secret.md) | POST `…/webhooks/{webhookId}/rotate` | `webhooks_manage` |

## Batch

Run up to 20 reads in one request. Guide: [Batch](https://tetrafi.mintlify.site/reference/conventions.md#read-several-resources-at-once).

| Endpoint | Method and path | API-key scopes |
| :- | :- | :- |
| [Batch reads](https://tetrafi.mintlify.site/api-reference/batch/batch-reads.md) | POST `/api/v1/batch` | None |


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