---
seo:
  description: Public REST API for interacting with UDX as a member.
sidebar:
  label: Overview
title: REST API
---
Public REST API for interacting with UDX as a member.

Version: 2026-07-15

- Server: `https://api.underdogexchange.com`
- Server: `https://api.uat.udx.underdogsports.com`

## API Keys

Programmatic credential management.

- [List API Keys](/api-reference/rest/api-keys/list-api-keys) — `GET /api_keys`
- [Create an API Key](/api-reference/rest/api-keys/create-api-key) — `POST /api_keys`
- [Revoke an API Key](/api-reference/rest/api-keys/revoke-api-key) — `DELETE /api_keys/{id}`

## Markets

Market catalog, order books, candlesticks, and trades.

- [List Markets](/api-reference/rest/markets/list-markets) — `GET /markets`
- [Get a Market](/api-reference/rest/markets/get-market) — `GET /markets/{ticker}`
- [Get a Market's Order Book](/api-reference/rest/markets/get-market-orderbook) — `GET /markets/{ticker}/orderbook`
- [Get a Market's Stats](/api-reference/rest/markets/get-market-stats) — `GET /markets/{ticker}/stats`
- [Get a Market's Candlesticks](/api-reference/rest/markets/get-market-candlesticks) — `GET /markets/{ticker}/candlesticks`
- [Get a Market's Trades](/api-reference/rest/markets/get-market-trades) — `GET /markets/{ticker}/trades`
- [List Order Books](/api-reference/rest/markets/list-orderbooks) — `GET /orderbooks`
- [List Trades](/api-reference/rest/markets/list-trades) — `GET /trades`

## Orders

Place, amend, cancel, and query orders.

- [List Orders](/api-reference/rest/orders/list-orders) — `GET /orders`
- [Place an Order](/api-reference/rest/orders/create-order) — `POST /orders`
- [Cancel Orders](/api-reference/rest/orders/cancel-orders) — `DELETE /orders`
- [Get an Order](/api-reference/rest/orders/get-order) — `GET /orders/{order_id}`
- [Cancel an Order](/api-reference/rest/orders/cancel-order) — `DELETE /orders/{order_id}`
- [Amend an Order](/api-reference/rest/orders/amend-order) — `POST /orders/{order_id}/amend`

## Portfolio

Account balances, positions, fills, settlements, accounts, and transfers.

- [Get Balance](/api-reference/rest/portfolio/get-balance) — `GET /portfolio/{account_id}/balance`
- [Get Positions](/api-reference/rest/portfolio/get-positions) — `GET /portfolio/positions`
- [List Fills](/api-reference/rest/portfolio/get-fills) — `GET /portfolio/fills`
- [Get Settlements](/api-reference/rest/portfolio/get-settlements) — `GET /portfolio/{account_id}/settlements`
- [List Accounts](/api-reference/rest/portfolio/list-accounts) — `GET /portfolio/accounts`
- [Create an Account](/api-reference/rest/portfolio/create-account) — `POST /portfolio/accounts`
- [Get an Account by Client Account ID](/api-reference/rest/portfolio/get-account-by-client-account-id) — `GET /portfolio/accounts/{client_account_id}`
- [List an Account's Grants](/api-reference/rest/portfolio/list-account-grants) — `GET /portfolio/accounts/{account_id}/grants`
- [Grant Account Access](/api-reference/rest/portfolio/create-grant) — `POST /portfolio/accounts/{account_id}/grants`
- [Revoke a Grant](/api-reference/rest/portfolio/revoke-grant) — `DELETE /portfolio/accounts/{account_id}/grants/{grant_id}`
- [Transfer Funds](/api-reference/rest/portfolio/transfer-between-accounts) — `POST /portfolio/transfers`

## Quotes

Create and manage quotes answering RFQs.

- [List Account Quotes](/api-reference/rest/quotes/list-account-quotes) — `GET /accounts/{account_id}/quotes`
- [Create a Quote](/api-reference/rest/quotes/create-quote) — `POST /quotes`
- [List RFQ quotes](/api-reference/rest/quotes/list-rfq-quotes) — `GET /rfqs/{rfq_id}/quotes`
- [Get a Quote](/api-reference/rest/quotes/get-quote) — `GET /rfqs/{rfq_id}/quotes/{quote_id}`
- [Cancel a Quote](/api-reference/rest/quotes/cancel-quote) — `DELETE /rfqs/{rfq_id}/quotes/{quote_id}`
- [Accept a Quote](/api-reference/rest/quotes/accept-quote) — `POST /rfqs/{rfq_id}/quotes/{quote_id}/accept`
- [Confirm an Accepted Quote](/api-reference/rest/quotes/confirm-accepted-quote) — `POST /rfqs/{rfq_id}/quotes/{quote_id}/confirm`

## Rate Limits

The authenticated member's REST request capacity.

- [Get the Caller's Rate Limit Profile](/api-reference/rest/rate-limits/get-rate-limit-profile) — `GET /rate_limit_profile`

## RFQs

Request quotes from makers.

- [List Account RFQs](/api-reference/rest/rfqs/list-account-rfqs) — `GET /accounts/{account_id}/rfqs`
- [List RFQs](/api-reference/rest/rfqs/list-rfqs) — `GET /rfqs`
- [Create an RFQ](/api-reference/rest/rfqs/create-rfq) — `POST /rfqs`
- [Get an RFQ](/api-reference/rest/rfqs/get-rfq) — `GET /rfqs/{rfq_id}`
- [Get RFQ Stats](/api-reference/rest/rfqs/get-rfq-stats) — `GET /rfq-stats`
- [List RFQ Stats by Series](/api-reference/rest/rfqs/list-rfq-stats-series) — `GET /rfq-stats/series`

## Users

The caller's identity and member's users.

- [Get the Current User](/api-reference/rest/users/get-current-user) — `GET /users/me`
- [List Users](/api-reference/rest/users/list-users) — `GET /users`
- [Replace a User's Scopes](/api-reference/rest/users/put-user-scopes) — `PUT /users/{user_id}/scopes`
- [List a User's API Keys](/api-reference/rest/users/list-user-api-keys) — `GET /users/{user_id}/api_keys`
- [Create an API Key for a User](/api-reference/rest/users/create-user-api-key) — `POST /users/{user_id}/api_keys`
- [Revoke a User's API Key](/api-reference/rest/users/revoke-user-api-key) — `DELETE /users/{user_id}/api_keys/{id}`