# Rails Trading Developer API Documentation

## Docs

- [](https://docs.rails.xyz/index.md)
- [Account Equity & Balances](https://docs.rails.xyz/latest/account-balance.md)
- [API Keys](https://docs.rails.xyz/latest/api-keys.md): Guide on How to Set up Your API Keys
- [Changelog](https://docs.rails.xyz/latest/changelog.md): Keep track of changes and upgrades to the Rails API
- [Deposit & Withdraw](https://docs.rails.xyz/latest/deposit-withdraw.md): Guide on How to Deposit/Withdraw Funds
- [Environments](https://docs.rails.xyz/latest/environments.md): Integration Environments for Market Makers
- [Error Reference](https://docs.rails.xyz/latest/error-reference/error-code.md): Rails WebSocket API represents an error with a code and a slug.
- [Funding](https://docs.rails.xyz/latest/funding.md)
- [Get Set Up With Rails](https://docs.rails.xyz/latest/get-set-up-with-rails.md): Quickstart guide for developers to begin using Rails Trading APIs
- [Introduction](https://docs.rails.xyz/latest/introduction.md): Welcome to Rails Trading Developer API Documentation
- [Navigating the Docs](https://docs.rails.xyz/latest/navigating-the-docs.md): Guide on how to use the API documentation effectively.
- [Account Information](https://docs.rails.xyz/latest/platform-overview/account-info.md): Checking Your Account Information
- [Authorization](https://docs.rails.xyz/latest/platform-overview/authorization.md): Understanding API authorization
- [FAQs](https://docs.rails.xyz/latest/platform-overview/faqs.md): Frequently asked questions about the Rails API
- [Market Data](https://docs.rails.xyz/latest/platform-overview/market-data.md): Understanding market specific data
- [Open Orders](https://docs.rails.xyz/latest/platform-overview/open-orders.md): Understanding and managing open orders
- [Order Book](https://docs.rails.xyz/latest/platform-overview/order-book.md): Maintaining a local order book
- [Order Cancellation](https://docs.rails.xyz/latest/platform-overview/order-cancellation.md): Understanding order cancellation strategies and best practices
- [Order Creation](https://docs.rails.xyz/latest/platform-overview/order-creation.md): Understanding order types and creation workflows
- [Order Modification](https://docs.rails.xyz/latest/platform-overview/order-modification.md): Understanding order modification workflows
- [Rate Limits](https://docs.rails.xyz/latest/platform-overview/rate-limits.md): API Rate Limits and Usage Policies
- [Recent Trades](https://docs.rails.xyz/latest/platform-overview/recent-trades.md): Getting recent trade executions on a market
- [Risk Management](https://docs.rails.xyz/latest/platform-overview/risk-management.md): How Rails protects accounts through liquidation and proactive order cancellation.
- [Position Metrics, Margin & Liquidation Price](https://docs.rails.xyz/latest/position-metrics.md)
- [Cancel Orders](https://docs.rails.xyz/latest/rest-api/cancel-orders.md): This endpoint cancels orders by market or across all markets.
- [Get Access Token](https://docs.rails.xyz/latest/rest-api/get-access-token.md): This endpoint generates an access token for REST and WebSocket APIs.
- [Get Account Balances](https://docs.rails.xyz/latest/rest-api/get-account-balances.md): This endpoint retrieves the account balances.
- [Get Account Completed Orders](https://docs.rails.xyz/latest/rest-api/get-account-completed-orders.md): This endpoint retrieves the account completed orders.
- [Get Account Deposits](https://docs.rails.xyz/latest/rest-api/get-account-deposits.md): This endpoint retrieves the account deposits.
- [Get Account Fundings](https://docs.rails.xyz/latest/rest-api/get-account-fundings.md): This endpoint retrieves the account fundings.
- [Get Account Open Order By ID](https://docs.rails.xyz/latest/rest-api/get-account-open-order-by-id.md): This endpoint retrieves an account open order by order ID or client request ID.
- [Get Account Open Orders](https://docs.rails.xyz/latest/rest-api/get-account-open-orders.md): This endpoint retrieves the account open orders.
- [Get Account Positions](https://docs.rails.xyz/latest/rest-api/get-account-positions.md): This endpoint retrieves the account positions by market.
- [Get Account Withdrawals](https://docs.rails.xyz/latest/rest-api/get-account-withdrawals.md): This endpoint retrieves the account withdrawals.
- [Get Market Data](https://docs.rails.xyz/latest/rest-api/get-market-data.md): This endpoint retrieves market data for a given list of markets.
- [Get Order Book](https://docs.rails.xyz/latest/rest-api/get-order-book.md): This endpoint retrieves the latest order book snapshot for a given market.
- [Get Order Book v2](https://docs.rails.xyz/latest/rest-api/get-order-book-v2.md): This endpoint retrieves the latest order book snapshot for a given market with a timestamp.
- [Get Order By ID](https://docs.rails.xyz/latest/rest-api/get-order-by-id.md): This endpoint retrieves order details by order ID or client request ID.
- [Get Product Specifications v2](https://docs.rails.xyz/latest/rest-api/get-product-specifications.md): This endpoint retrieves product specifications.
- [Get Supported Markets](https://docs.rails.xyz/latest/rest-api/get-supported-markets.md): This endpoint retrieves all the supported markets by our exchange.
- [Order Book Stream](https://docs.rails.xyz/latest/websocket-api/websocket-v1/order-book/order-book-stream.md)
- [Overview](https://docs.rails.xyz/latest/websocket-api/websocket-v1/order-book/overview.md)
- [Ping](https://docs.rails.xyz/latest/websocket-api/websocket-v1/order-book/ping.md)
- [Overview](https://docs.rails.xyz/latest/websocket-api/websocket-v1/order-creation/overview.md)
- [Ping](https://docs.rails.xyz/latest/websocket-api/websocket-v1/order-creation/ping.md)
- [Completed Orders Stream](https://docs.rails.xyz/latest/websocket-api/websocket-v1/transaction/completed-orders-stream.md)
- [Overview](https://docs.rails.xyz/latest/websocket-api/websocket-v1/transaction/overview.md)
- [Ping](https://docs.rails.xyz/latest/websocket-api/websocket-v1/transaction/ping.md)
- [Order Book Stream](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-book-stream.md)
- [Cancel Order By ID](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/cancel-order-by-id.md)
- [Create Order](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/create-order.md)
- [Modify Order](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/modify-order.md)
- [Order Filled Notifications](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/order-filled-notifications.md)
- [Order Rejected Notifications](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/order-rejected-notifications.md)
- [Overview](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/overview.md)
- [Update Leverage](https://docs.rails.xyz/latest/websocket-api/websocket-v2/order-creation-stream/update-leverage.md)
- [Overview](https://docs.rails.xyz/latest/websocket-api/websocket-v2/overview.md)
- [Ping](https://docs.rails.xyz/latest/websocket-api/websocket-v2/ping.md)
- [Subscribe](https://docs.rails.xyz/latest/websocket-api/websocket-v2/subscribe.md)
- [Public Trade Stream](https://docs.rails.xyz/latest/websocket-api/websocket-v2/trade-stream.md)
- [Trade Stream](https://docs.rails.xyz/latest/websocket-api/websocket-v2/transaction-stream.md)
- [Unsubscribe](https://docs.rails.xyz/latest/websocket-api/websocket-v2/unsubscribe.md)

## OpenAPI Specs

- [account](https://docs.rails.xyz/openapi/account.json)
- [market](https://docs.rails.xyz/openapi/market.json)
- [order](https://docs.rails.xyz/openapi/order.json)
- [auth](https://docs.rails.xyz/openapi/auth.json)
- [openapi](https://docs.rails.xyz/rest-api/openapi.json)

## AsyncAPI Specs

- [test](https://docs.rails.xyz/latest/asyncapi/test.json)