# API Documentation - [API](https://pacifica.gitbook.io/docs/api-documentation/api.md) - [REST API](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api.md) - [Markets](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets.md): This sections covers details for interacting with all perpetual futures markets listed on Pacifica. - [Get market info](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-market-info.md): This endpoint allows users to get exchange information, including market specifications for all available trading pairs. - [Get prices](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-prices.md): This endpoint allows users to get price information for all symbols, including mark prices, funding rates, and market statistics. - [Get candle data](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-candle-data.md): This endpoint allows users to get historical price candles for a specific market and time interval. - [Get mark price candle data](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-mark-price-candle-data.md): This endpoint allows users to get historical mark price candles for a specific market and time interval. - [Get orderbook](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-orderbook.md): This endpoint allows users to retrieve the current orderbook (bid/ask levels) for a specified trading symbol. - [Get recent trades](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-recent-trades.md): This endpoint allows users to get recent trades for a specific market. - [Get historical funding](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-historical-funding.md): This endpoint retrieves the historical funding for a particular symbol - [Get fee levels](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-fee-levels.md): This endpoint returns all fee level tiers and their corresponding maker and taker fee rates. - [Get loan pool](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/markets/get-loan-pool.md): This endpoint returns the current state of the loan pool including utilization, borrow and lend rates. - [Account](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account.md): This sections covers details for interacting with user accounts on Pacifica. - [Get account info](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-account-info.md): This endpoint allows users to get all high-level account info such as balance, fee level, equity, etc. - [Get account settings](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-account-settings.md): This endpoint allows users to get account margin and leverage settings (if they are not at default values) - [Update leverage](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/update-leverage.md): This endpoint allows users to change their account leverage for a specific trading pair. For open positions, users can only increase the leverage setting. - [Update margin mode](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/update-margin-mode.md): This endpoint allows users to switch between isolated and cross margin modes for a specific trading pair. For open positions, users cannot change the margin mode. - [Get positions](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-positions.md): This endpoint allows users to get current positions. - [Get trade history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-trade-history.md): This endpoint allows users to get trade history - [Get funding history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-funding-history.md): This endpoint allows users to get funding history. - [Get account equity history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-account-equity-history.md): This endpoint allows users to get account equity and PnL history (over time). - [Get account balance history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-account-balance-history.md): This endpoint allows users to get account balance history. Returns all balance effects that affects the queried account. - [Request withdrawal](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/request-withdrawal.md): This endpoint allows users to request withdrawal. - [Get account loan info](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-account-loan-info.md): This endpoint returns loan and collateral information for a given account under unified margin. - [Add isolated margin](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/add-isolated-margin.md): This endpoint allows users to add margin to an isolated position. - [Update spot settings](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/update-spot-settings.md): This endpoint allows users to update spot asset settings for unified margin. - [Toggle auto-lending](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/toggle-auto-lending.md): This endpoint allows users to enable or disable automatic lending. - [Get spot balance history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-spot-balance-history.md): This endpoint allows users to get spot asset balance history. - [Withdraw spot asset](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/withdraw-spot-asset.md): This endpoint allows users to withdraw a spot asset. - [Get pending spot withdrawals](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-pending-spot-withdrawals.md): This endpoint returns pending spot asset withdrawals. - [Get spot deposit history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-spot-deposit-history.md): This endpoint returns spot asset deposit history. - [Get spot withdrawal history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/account/get-spot-withdrawal-history.md): This endpoint returns spot asset withdrawal history. - [Vaults](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults.md): REST API endpoints for creating, funding, configuring, and listing vaults. - [Create vault](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/create-vault.md): Create a new vault (lake) and optionally set its initial configuration and seed deposit. - [Claim vault referral code](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/claim-vault-referral-code.md): Claim a referral code for an existing vault. - [Deposit to vault](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/deposit-to-vault.md): Deposit funds into a vault and receive vault shares. - [Claim vault manager](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/claim-vault-manager.md): Claim the manager role on a fresh vault. - [Withdraw from vault](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/withdraw-from-vault.md): Redeem vault shares and withdraw funds from a vault. - [Update vault deposit cap](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/update-vault-deposit-cap.md): Update or clear the deposit cap for a vault. - [Add vault whitelist](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/add-vault-whitelist.md): Add tradable symbols to a vault whitelist. - [Remove vault whitelist](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/remove-vault-whitelist.md): Remove tradable symbols from a vault whitelist. - [Add vault blacklist](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/add-vault-blacklist.md): Add blocked symbols to a vault blacklist. - [Remove vault blacklist](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/remove-vault-blacklist.md): Remove blocked symbols from a vault blacklist. - [Add vault max leverage](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/add-vault-max-leverage.md): Add per-symbol max leverage limits for a vault. - [Remove vault max leverage](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/remove-vault-max-leverage.md): Remove per-symbol max leverage limits from a vault. - [List vaults](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/vaults/list-vaults.md): List all vaults and optionally include the querying account's share balance. - [Subaccounts](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/subaccounts.md) - [Create subaccount](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/subaccounts/create-subaccount.md): This endpoint allows regular accounts to create subaccounts with a secure authentication scheme. Both the main account and subaccount must sign to establish the relationship. - [List subaccounts](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/subaccounts/list-subaccounts.md): Lists all subaccounts associated with a main (parent) account. Returns address, balance, and other account details for each subaccount. - [Subaccount fund transfer](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/subaccounts/subaccount-fund-transfer.md): This endpoint allows transfer of funds between main and subaccounts - [Subaccount spot transfer](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/subaccounts/subaccount-spot-transfer.md): This endpoint allows users to transfer spot assets between a main account and its subaccounts - [Spot](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/spot.md) - [Get spot assets](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/spot/get-spot-assets.md): This endpoint returns a list of all spot assets available on the exchange, including their trading parameters and collateral eligibility. - [Get bridge info](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/spot/get-bridge-info.md): This endpoint returns bridge parameters for all spot assets, including deposit minimums, withdrawal fees, and on-chain program addresses. - [Get bridge parameters](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/spot/get-bridge-parameters.md): This endpoint returns bridge parameters for a single spot asset by symbol, including deposit minimums, withdrawal fees, and on-chain program addresses. - [Orders](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders.md): This sections covers details for interacting with current and historical orders on Pacifica. - [Create market order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/create-market-order.md): This endpoint allows users to create a new market order with optional take profit and stop loss levels. - [Create limit order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/create-limit-order.md): This endpoint allows users to create a new limit order with optional take profit and stop loss levels. - [Create stop order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/create-stop-order.md): This endpoint allows users to create stop order. - [Create position TP/SL](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/create-position-tp-sl.md): This endpoint allows users to set take profit and stop loss levels for an existing position. - [Cancel order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/cancel-order.md): This endpoint allows users to cancel an existing order. - [Cancel all orders](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/cancel-all-orders.md): This endpoint allows users to cancel all orders for all/given symbol(s). - [Cancel stop order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/cancel-stop-order.md): This endpoint allows users to cancel a stop order by its (CL)OID. - [Edit order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/edit-order.md): This endpoint allows users to edit an existing limit order by modifying its size and/or price. - [Batch order](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/batch-order.md): This endpoint allows users to submit multiple order operations in a single request. Batched orders are executed in the order they are batched in, and will not be split up by other users' orders. - [Get open orders](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/get-open-orders.md): This endpoint allows users to get open orders on their account. - [Get order history](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/get-order-history.md): This endpoint allows users to get a summarized order history. - [Get order history by ID](https://pacifica.gitbook.io/docs/api-documentation/api/rest-api/orders/get-order-history-by-id.md): This endpoint allows users to get order history by id. - [Websocket](https://pacifica.gitbook.io/docs/api-documentation/api/websocket.md) - [Subscriptions](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions.md) - [Prices](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/prices.md): Streams all symbols' price information on Pacifica as they update - [Orderbook](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/orderbook.md): Streams book data for given symbol at a set aggregation level as they update - [Best bid offer (BBO)](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/best-bid-offer-bbo.md): Real-time updates of the best bid and ask prices and amounts for a specific symbol. Updates are sent whenever the top of book changes. - [Trades](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/trades.md): Streams all trades on the taker side as they occur in a chosen market. - [Candle](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/candle.md): Streams candle information for given symbol and candle time interval - [Mark price candle](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/mark-price-candle.md): Streams real-time mark price candlestick data for a specific market. - [Account margin](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-margin.md): Streams all changes made to an account's margin mode in any market. - [Account leverage](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-leverage.md): Streams all changes made to an account's max leverage any market. - [Account info](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-info.md): Streams all changes made to an account's overall info such as equity, balance, order count, etc. - [Account positions](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-positions.md): Streams all changes made to an account's positions in any market. A position that has been fully closed will be streamed and return empty. - [Account order updates](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-order-updates.md): Streams the amount and nature of changes made to any of an account's open orders in any market. - [Account trades](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-trades.md): Streams all trades that take place for an account - [Account transfers](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/subscriptions/account-transfers.md): Streams deposit, withdrawal, and transfer events for an account. - [Trading operations](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations.md) - [Create market order](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/create-market-order.md): This request type allows users to place market orders through Pacifica's websocket API. - [Create limit order](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/create-limit-order.md): This request type allows users to place limit orders through Pacifica's websocket API. - [Edit order](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/edit-order.md): This request type allows users to modify existing orders (price and/or size) through websocket API in one request. - [Batch order](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/batch-order.md): This endpoint allows users to submit multiple order operations in a single websocket request. - [Cancel order](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/cancel-order.md): This request type allows users to cancel orders through Pacifica's websocket API. - [Cancel all orders](https://pacifica.gitbook.io/docs/api-documentation/api/websocket/trading-operations/cancel-all-orders.md): This request type allows users to cancel all orders through Pacifica's websocket API. - [Signing](https://pacifica.gitbook.io/docs/api-documentation/api/signing.md): Pacifica uses deterministic JSON formatting to generate Ed25519 signatures for API authentication. - [Implementation](https://pacifica.gitbook.io/docs/api-documentation/api/signing/implementation.md): The following guide provides a steps-by-step breakdown of Pacifica's signing implementation - [Operation Types](https://pacifica.gitbook.io/docs/api-documentation/api/signing/operation-types.md): The following table provides a list of all "type"s required by the signature header and their corresponding API endpoints - [Error Handling](https://pacifica.gitbook.io/docs/api-documentation/api/signing/error-handling.md): An invalid signed message can result in a variety of Status 400 errors. The following illustrate error messages and common causes. - [Hardware Wallet](https://pacifica.gitbook.io/docs/api-documentation/api/signing/hardware-wallet.md) - [API Agent Keys](https://pacifica.gitbook.io/docs/api-documentation/api/signing/api-agent-keys.md) - [Rate limits](https://pacifica.gitbook.io/docs/api-documentation/api/rate-limits.md): Pacifica uses a credit-based rate limiting system with a 60-second rolling window. - [API Config Keys](https://pacifica.gitbook.io/docs/api-documentation/api/rate-limits/api-config-keys.md): The following guide covers the creation and usage of Pacifica API Config Keys. - [Market symbols](https://pacifica.gitbook.io/docs/api-documentation/api/market-symbols.md): Symbols accepted by the Pacifica API are CASE SENSITIVE. - [Tick and lot size](https://pacifica.gitbook.io/docs/api-documentation/api/tick-and-lot-size.md): The following doc describes how tick and lot size, as well as rounding, are handled at an API level when Pacifica's endpoints receives requests with price and amount fields. - [Last order ID](https://pacifica.gitbook.io/docs/api-documentation/api/last-order-id.md): Pacifica uses last order ID as an exchange-wide identifier to order all exchange events - [Error codes](https://pacifica.gitbook.io/docs/api-documentation/api/error-codes.md): This section provides a comprehensive list and definition of all error codes generated by the Pacifica API - [API FAQ](https://pacifica.gitbook.io/docs/api-documentation/api/api-faq.md) - [403 CloudFront](https://pacifica.gitbook.io/docs/api-documentation/api/api-faq/403-cloudfront.md): Common error caused by GET requests with an empty request body. - [Delayed account\_positions](https://pacifica.gitbook.io/docs/api-documentation/api/api-faq/delayed-account_positions.md): Potential delay of snapshot endpoints and best practice for reconstructing local state - [Changelog](https://pacifica.gitbook.io/docs/api-documentation/changelog.md): Changelog for Pacifica's API documentation --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://pacifica.gitbook.io/docs/api-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.