{"openapi":"3.0.0","paths":{"/rest/v3/me":{"get":{"description":"Retrieve the authenticated member's profile, including their unique identifier (SN), email,       registration level and account status.</br></br>      <strong>Rate Limit:</strong> 1 request per 1 second.","operationId":"current-member","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"responses":{"200":{"description":"Current member details were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"Get current member details","tags":["Member Info"]}},"/rest/v3/me/fees/trading":{"get":{"description":"Retrieve the maker and taker trading fee rates for all markets, specific to the authenticated member.       Fees may vary based on volume tier or promotions.</br></br>      <strong>Rate Limit:</strong> 1 request per 2 seconds.","operationId":"trading-fees","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"responses":{"200":{"description":"The trading fees of each market were retrieved, in the `data` list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradingFeesResponse"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"Trading Fees","tags":["Member Info"]}},"/rest/v3/currencies":{"get":{"description":"Retrieve a list of all supported currencies, including their symbol, name, type (crypto/fiat), precision,       deposit and withdrawal information (minimum amounts, fees, enabled status) and available networks.</br>      To obtain the currency icon, use this URL pattern:       <code>https://statics.foxbit.com.br/icons/colored/[CURRENCY_SYMBOL].svg</code></br></br>      <strong>Cache:</strong> 1 minute.</br>      <strong>Rate Limit:</strong> 6 requests per 1 second.","operationId":"list-currencies","parameters":[{"name":"category","required":false,"in":"query","description":"The currency category to filter currencies","schema":{"example":"PREDICTION","type":"string","enum":["PREDICTION"]}}],"responses":{"200":{"description":"A list of currencies was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Currencies"}}}},"400":{"description":"Invalid category"}},"summary":"List currencies","tags":["Market Data"]}},"/rest/v3/markets":{"get":{"description":"Retrieve a list of all available trading markets, including their symbols, base/quote currencies,       precision settings, minimum quantities, default fees and allowed order types.</br></br>      <strong>Cache:</strong> 1 minute.</br>      <strong>Rate Limit:</strong> 6 requests per 1 second.","operationId":"list-markets","parameters":[{"name":"category","required":false,"in":"query","description":"Filter by market category. Use `PREDICTION` to list only prediction markets, or `ALL` to list every market","schema":{"example":"PREDICTION","type":"string","enum":["PREDICTION","ALL"]}}],"responses":{"200":{"description":"A list of markets was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Markets"}}}},"400":{"description":"Invalid category"}},"summary":"List markets","tags":["Market Data"]}},"/rest/v3/markets/quotes":{"get":{"description":"Simulate a trade and get an estimated quotation based on a market and side (BUY/SELL).       You can specify either the <strong>amount</strong> (in quote currency, e.g. BRL) or the       <strong>quantity</strong> (in base currency, e.g. BTC) to receive the corresponding conversion.</br></br>      <strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"get-quote","parameters":[{"name":"side","required":true,"in":"query","description":"Book side for quote search","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}},{"name":"base_currency","required":true,"in":"query","description":"The base currency is the currency against which exchange rates are typically quoted.\n      It serves as the reference point for determining the value of other currencies in a currency pair.\n      (e.g. BTC in BTCBRL)","schema":{"example":"btc","type":"string"}},{"name":"quote_currency","required":true,"in":"query","description":"The quote currency is the second currency in a currency pair.\n      It represents the value of one unit of the base currency in terms of the quote currency.\n      (e.g. BRL in BTCBRL)","schema":{"example":"brl","type":"string"}},{"name":"amount","required":false,"in":"query","description":"Amount of the quote currency to be quoted (e.g. BRL in BTCBRL).\n      Provide <strong>amount</strong> or <strong>quantity</strong>: at least one is required.\n      If both are sent, <strong>amount</strong> takes precedence","schema":{"example":"1000.00","type":"string"}},{"name":"quantity","required":false,"in":"query","description":"Quantity of the base currency to be quoted (e.g. BTC in BTCBRL).\n      Provide <strong>quantity</strong> or <strong>amount</strong>: at least one is required.\n      If both are sent, <strong>amount</strong> takes precedence","schema":{"type":"string"}}],"responses":{"200":{"description":"A market quotation based on a market and volume basis was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}}},"400":{"description":"Invalid or missing query parameters"},"404":{"description":"Market not found or not available"}},"summary":"Get a market quotation","tags":["Market Data"]}},"/rest/v3/markets/{market_symbol}/orderbook":{"get":{"description":"Retrieve a snapshot of the order book for a specific market, containing arrays of bids and asks       with price and quantity at each level. The depth can be limited via query parameter.</br>      See also [how to manage a local copy of the order book](#tag/Tutorials/How-to-manage-a-local-copy-of-the-order-book).</br></br>      <strong>Rate Limit:</strong> 10 requests per 2 seconds.","operationId":"get-orderbook","parameters":[{"name":"market_symbol","required":true,"in":"path","description":"The symbol of the market from which the order book data will be exported","schema":{"example":"btcbrl","type":"string"}},{"name":"depth","required":false,"in":"query","description":"The maximum number of asks and bids to be exported","schema":{"maximum":300,"default":300,"example":50,"type":"integer"}}],"responses":{"200":{"description":"The order book data was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderbookDepth"}}}},"404":{"description":"Market not found or not available"}},"summary":"Get order book","tags":["Market Data"]}},"/rest/v3/markets/{market_symbol}/candlesticks":{"get":{"description":"Retrieve OHLCV (Open, High, Low, Close, Volume) candlestick data for a specific market and time interval.       Useful for charting and technical analysis. Supports multiple intervals from 1 minute to 1 month.</br></br>      <strong>Rate Limit:</strong> 15 requests per 2 seconds.","operationId":"get-candlesticks","parameters":[{"name":"market_symbol","required":true,"in":"path","description":"The symbol of the market from which the candlestick data will be retrieved","schema":{"example":"btcbrl","type":"string"}},{"name":"interval","required":true,"in":"query","description":"The time interval of each candlestick. Supported intervals range from 1 minute to 1 month","examples":{"1m":{"value":"1m","summary":"1 minute interval"},"5m":{"value":"5m","summary":"5 minutes interval"},"15m":{"value":"15m","summary":"15 minutes interval"},"1d":{"value":"1d","summary":"1 day interval"},"1M":{"value":"1M","summary":"1 month interval"}},"schema":{"type":"string","enum":["1m","5m","15m","30m","1h","2h","4h","6h","12h","1d","1w","2w","1M"]}},{"name":"start_time","required":false,"in":"query","description":"The earliest date in ticker history, it can be entered with minutes accuracy","examples":{"example1":{"value":"2022-07-18T00:00","summary":"Start of day"},"example2":{"value":"2022-08-19T12:10","summary":"Specific time"}},"schema":{"type":"string"}},{"name":"end_time","required":false,"in":"query","description":"The most current date in ticker history, can be entered with a precision of minutes","examples":{"example1":{"value":"2022-08-19T12:00","summary":"Start of hour"},"example2":{"value":"2022-08-19T12:12","summary":"Specific minute"}},"schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The maximum number of ticks to be returned (max 500)","examples":{"default":{"value":100,"summary":"Default limit"},"max":{"value":500,"summary":"Maximum allowed"}},"schema":{"minimum":1,"maximum":500,"default":100,"type":"integer"}},{"name":"order_direction","required":false,"in":"query","description":"Sort direction of the returned candlesticks by timestamp. `ASC` returns oldest first, `DESC` returns most recent first","schema":{"default":"ASC","type":"string","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"It returns an array of candlesticks, where each candlestick is itself an array.\n    All values are strings of decimals, except the number of trades, which is a number.\n    <table>\n      <tr><th>Index</th><th>Field</th><th>Description</th></tr>\n      <tr><td>0</td><td>Open time</td><td>UTC, milliseconds since 1/1/1970 (POSIX)</td></tr>\n      <tr><td>1</td><td>Open price</td><td>Close price of the previous candlestick. On a market gap\n        it may fall outside the high/low range of its own candlestick</td></tr>\n      <tr><td>2</td><td>Highest price</td><td></td></tr>\n      <tr><td>3</td><td>Lowest price</td><td></td></tr>\n      <tr><td>4</td><td>Close price</td><td></td></tr>\n      <tr><td>5</td><td>Close time</td><td>UTC, milliseconds since 1/1/1970 (POSIX)</td></tr>\n      <tr><td>6</td><td>Base volume</td><td></td></tr>\n      <tr><td>7</td><td>Quote volume</td><td></td></tr>\n      <tr><td>8</td><td>Number of trades</td><td>Number, not a string</td></tr>\n      <tr><td>9</td><td>Taker buy base volume</td><td></td></tr>\n      <tr><td>10</td><td>Taker buy quote volume</td><td></td></tr>\n    </table>\n    <strong>Schema limitation:</strong> this document is OpenAPI 3.0, which cannot type an array\n    per position (<code>prefixItems</code> only exists in 3.1). The machine-readable schema is\n    therefore broader than the response: it declares 11 items of <code>string</code> or <code>number</code>,\n    while the actual value is fixed per index as described in the table above. Generated clients\n    model it as an array of <code>string</code> or <code>number</code> and must narrow by index.","content":{"application/json":{"schema":{"example":[["1692918000000","127772.05150000","128467.99980000","127750.01000000","128353.99990000","1692918060000","0.17080431","21866.35948786",66,"0.12073605","15466.34096391"],["1692921600000","128353.99990000","128353.99990000","127922.00030000","128339.99990000","1692921660000","0.12355465","15851.30631056",45,"0.11030870","14156.75206627"]],"type":"array","items":{"$ref":"#/components/schemas/Candlestick"}}}}},"400":{"description":"Invalid interval or date range"},"404":{"description":"Market not found or not available"}},"summary":"Get candlesticks","tags":["Market Data"]}},"/rest/v3/markets/{market_symbol}/ticker/24hr":{"get":{"description":"Retrieve real-time 24-hour ticker information for a given market, including last trade price,       price change, volume, high/low and best bid/ask with volume.</br></br>      <strong>Rate Limit:</strong> 12 requests per 2 seconds.","operationId":"get-ticker","parameters":[{"name":"market_symbol","required":true,"in":"path","description":"The symbol of the market from which the ticker data will be retrieved","schema":{"example":"btcbrl","type":"string"}}],"responses":{"200":{"description":"The ticker data was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTickerWithBestResponse"}}}},"404":{"description":"Market not found or not available"}},"summary":"Get ticker for a specific market","tags":["Market Data"]}},"/rest/v3/markets/ticker/24hr":{"get":{"description":"Retrieve 24-hour ticker data for all active markets in a single request. Each ticker includes       last trade, price change, volume and best bid/ask prices.</br>      To obtain the currency icon, use this URL pattern:       <code>https://statics.foxbit.com.br/icons/colored/[CURRENCY_SYMBOL].svg</code></br></br>      <strong>Cache:</strong> 10 seconds.</br>      <strong>Rate Limit:</strong> 2 requests per 4 seconds.","operationId":"get-ticker-24h","parameters":[],"responses":{"200":{"description":"The ticker data was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTickerResponse"}}}}},"summary":"Get all markets ticker","tags":["Market Data"]}},"/rest/v3/markets/{market_symbol}/trades/history":{"get":{"description":"Retrieve the most recent public trades for a specific market. Each trade includes price, volume,       taker side and timestamp.</br>      If <code>start_time</code> and <code>end_time</code> are not provided,       the most recent trades are returned based on the <code>page_size</code> parameter.</br></br>      <strong>Cache:</strong> 10 seconds.</br>      <strong>Rate Limit:</strong> 5 requests per 2 seconds.","operationId":"get-public-trades","parameters":[{"name":"market_symbol","required":true,"in":"path","description":"The symbol of the market from which the trades will be retrieved","schema":{"example":"btcbrl","type":"string"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, in the format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS","examples":{"dateOnly":{"value":"2024-01-01","summary":"Date only"},"dateTime":{"value":"2024-01-01T06:25:09","summary":"Date and time"}},"schema":{"type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, in the format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS","examples":{"dateOnly":{"value":"2024-01-01","summary":"Date only"},"dateTime":{"value":"2024-01-01T06:25:09","summary":"Date and time"}},"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","examples":{"first":{"value":1,"summary":"First page"},"tenth":{"value":10,"summary":"Tenth page"}},"schema":{"minimum":1,"default":1,"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned","examples":{"default":{"value":50,"summary":"Default page size"},"max":{"value":100,"summary":"Larger page size"}},"schema":{"minimum":1,"maximum":200,"default":50,"type":"integer"}}],"responses":{"200":{"description":"The trades data was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicTrades"}}}},"400":{"description":"Invalid date filters"},"404":{"description":"Market not found or not available"}},"summary":"Get trades","tags":["Market Data"]}},"/rest/v3/markets/sparkline/{window}":{"get":{"description":"Retrieve sparkline price data for one or more markets over a specific time window.       Returns an array of timestamp/price data points per market, useful for rendering mini price charts.       Up to 20 markets can be queried at once.</br></br>      <strong>Cache:</strong> 10 seconds.</br>      <strong>Rate Limit:</strong> 3 requests per 2 seconds.","operationId":"get-sparkline","parameters":[{"name":"window","required":true,"in":"path","description":"The time window covered by the sparkline\n    <table>\n      <thead>\n        <tr>\n          <th>Window</th>\n          <th>Coverage</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>hour</td>\n          <td>Last hour</td>\n        </tr>\n        <tr>\n          <td>day</td>\n          <td>Last 24 hours</td>\n        </tr>\n        <tr>\n          <td>week</td>\n          <td>Last 7 days</td>\n        </tr>\n        <tr>\n          <td>month</td>\n          <td>Last 30 days</td>\n        </tr>\n        <tr>\n          <td>year</td>\n          <td>Last 365 days</td>\n        </tr>\n        <tr>\n          <td>all</td>\n          <td>Entire market history</td>\n        </tr>\n      </tbody>\n    </table>","schema":{"example":"week","enum":["hour","day","week","month","year","all"],"type":"string"}},{"name":"market_symbols","required":true,"in":"query","description":"Market symbols to include, sent in the query as a comma-separated list","style":"form","explode":false,"schema":{"maxItems":20,"example":["btcbrl","ethbrl","adabrl"],"type":"array","items":{"type":"string"}}},{"name":"interval","required":false,"in":"query","description":"Time interval for sparkline data points. Available intervals per window:\n      <table>\n        <tr>\n          <th>Window</th>\n          <th>Available Intervals</th>\n        </tr>\n        <tr>\n          <td>hour</td>\n          <td>1m</td>\n        </tr>\n        <tr>\n          <td>day</td>\n          <td>5m</td>\n        </tr>\n        <tr>\n          <td>week</td>\n          <td>1h</td>\n        </tr>\n        <tr>\n          <td>month</td>\n          <td>2h</td>\n        </tr>\n        <tr>\n          <td>year</td>\n          <td>1d</td>\n        </tr>\n        <tr>\n          <td>all</td>\n          <td>1w</td>\n        </tr>\n      </table>\n      If not specified, the default interval for the selected window will be used","schema":{"example":"1h","type":"string","enum":["1m","5m","1h","2h","1d","1w"]}}],"responses":{"200":{"description":"Sparkline data retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sparklines"}}}},"400":{"description":"Bad request - Invalid interval for the requested window or too many market symbols","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sparkline400"}}}},"404":{"description":"Invalid sparkline window"}},"summary":"Get sparkline","tags":["Market Data"]}},"/rest/v3/orders":{"post":{"description":"Submit a new order to the exchange. Multiple order types are supported — see the request body schema     for details on each type (Limit, Market, Instant, StopLimit, StopMarket, TrailingStopLimit, TrailingStopMarket, Oco).<br/>\n    Required API Key permissions: <strong>trade</strong></br></br>\n    <strong>Rate Limit:</strong> 30 requests per 2 seconds.\n    An order, after created, can be presented in the following states:\n    <table>\n      <tr>\n        <th>State</th>\n        <th>Description</th>\n      </tr>\n      <tr>\n        <td>ACTIVE</td>\n        <td>The order is in the matching queue, waiting for a match</td>\n      </tr>\n      <tr>\n        <td>PARTIALLY_FILLED</td>\n        <td>\n          Part of the order has been filled and the remaining quantity is in the matching queue, waiting for a match\n        </td>\n      </tr>\n      <tr>\n        <td>FILLED</td>\n        <td>The order has been fully filled and is no longer in the matching queue</td>\n      </tr>\n      <tr>\n        <td>PARTIALLY_CANCELED</td>\n        <td>\n          The order was partially traded, but the remaining quantity was canceled.\n          The order is no longer in the matching queue\n        </td>\n      </tr>\n      <tr>\n        <td>PENDING_CANCEL</td>\n        <td>\n          The order has been removed from the matching queue and is awaiting fund release to finalize the cancellation.\n          Further trades will not occur within this order\n        </td>\n      </tr>\n      <tr>\n        <td>CANCELED</td>\n        <td>\n          The order was completely canceled and is no longer in the matching queue.\n          There is no trade associated with this order\n        </td>\n      </tr>\n    </table>\n    The valid state transitions are:\n    <table>\n      <tr>\n        <th>From</th>\n        <th>To</th>\n        <th>When</th>\n      </tr>\n      <tr>\n        <td>ACTIVE</td>\n        <td>PARTIALLY_FILLED</td>\n        <td>Part of the order quantity is executed</td>\n      </tr>\n      <tr>\n        <td>ACTIVE / PARTIALLY_FILLED</td>\n        <td>FILLED</td>\n        <td>The full order quantity is executed</td>\n      </tr>\n      <tr>\n        <td>ACTIVE / PARTIALLY_FILLED</td>\n        <td>PENDING_CANCEL</td>\n        <td>A cancellation was requested and is waiting for fund release</td>\n      </tr>\n      <tr>\n        <td>ACTIVE / PENDING_CANCEL</td>\n        <td>CANCELED</td>\n        <td>The order is canceled without any executed trades</td>\n      </tr>\n      <tr>\n        <td>PARTIALLY_FILLED / PENDING_CANCEL</td>\n        <td>PARTIALLY_CANCELED</td>\n        <td>The order is canceled after partial execution</td>\n      </tr>\n    </table>\n    FILLED, CANCELED and PARTIALLY_CANCELED are terminal states.\n    STOP_LIMIT and STOP_MARKET orders rest outside the order book until the stop price is reached;\n    once triggered, they enter the book as LIMIT and MARKET orders respectively, following the states above.<br/><br/>\n    An OCO order places a take-profit LIMIT at <b>price</b> and arms a stop-loss STOP_LIMIT at\n    <b>stop_price</b>/<b>stop_limit_price</b> under a single order id. The first leg to activate\n    wins and the other is canceled: a first trade of the take-profit cancels the stop-loss; the\n    trigger of the stop-loss cancels the take-profit and the order's <b>price</b> becomes\n    <b>stop_limit_price</b>. A BUY OCO locks <b>max(price, stop_limit_price) × quantity</b>.\n    Canceling the order cancels both legs. OCO orders are always GTC and never post-only.\n    The <b>order_type</b> list of the markets endpoints says where OCO is available.","operationId":"create-order","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}}},"responses":{"201":{"description":"An order was created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreated"}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"422":{"description":"Invalid symbol: the market was not found or is not available (code 4004), or the order was refused by the exchange (codes 4001, 4008 and 5005; a 4008 detail does not name the rule)"}},"summary":"Create an order","tags":["Trading"]},"get":{"description":"Retrieve a paginated list of orders for the authenticated member.       Supports filtering by market, side, state and date range.       By default, returns orders from the last 90 days in descending order.</br></br>      <strong>Rate Limit:</strong> 30 requests per 2 seconds.","operationId":"list-orders","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-01T22:06:32.999Z","type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-18T22:06:32.999Z","type":"string"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned, maximum of 100","schema":{"minimum":1,"maximum":100,"default":10,"example":10,"type":"integer"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","schema":{"minimum":1,"default":1,"example":1,"type":"integer"}},{"name":"market_symbol","required":false,"in":"query","description":"The market where the order was placed","schema":{"example":"btcbrl","type":"string"}},{"name":"state","required":false,"in":"query","description":"The execution state of the orders","schema":{"example":"ACTIVE","type":"string","enum":["ACTIVE","CANCELED","FILLED","PARTIALLY_CANCELED","PARTIALLY_FILLED"]}},{"name":"side","required":false,"in":"query","description":"The order book side where the order was placed","schema":{"example":"BUY","type":"string","enum":["BUY","SELL"]}},{"name":"sub_account_type","required":false,"in":"query","description":"The sub-account type associated with the orders","schema":{"type":"string","enum":["PREDICTION"]}}],"responses":{"200":{"description":"A list of orders was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders"},"example":{"data":[{"id":"1234567890","sn":"OKMAKSDHRVVREK","client_order_id":"451637946501","market_symbol":"btcbrl","side":"BUY","type":"LIMIT","state":"ACTIVE","price":"290000.0","price_avg":"0.0","quantity":"0.42","quantity_executed":"0.0","instant_amount":null,"instant_amount_executed":null,"created_at":"2021-02-15T22:06:32.999Z","trades_count":0,"fee_paid":"0.0","post_only":false,"time_in_force":"GTC","cancellation_reason":null,"cancellation_reason_order_id":null,"stp":"EXPIRE_TAKER","slippage_tolerance":"0.025"},{"id":"1234567889","sn":"OLG27EIEH6QHCY","client_order_id":null,"market_symbol":"btcbrl","side":"SELL","type":"LIMIT","state":"CANCELED","price":"310000.0","price_avg":"0.0","quantity":"0.1","quantity_executed":"0.0","instant_amount":null,"instant_amount_executed":null,"created_at":"2021-02-15T21:58:10.123Z","trades_count":0,"fee_paid":"0.0","post_only":true,"time_in_force":"GTC","cancellation_reason":1,"cancellation_reason_order_id":null,"stp":"EXPIRE_TAKER","slippage_tolerance":"0.025"}]}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List orders","tags":["Trading"]}},"/rest/v3/orders/batch":{"post":{"description":"Submit multiple orders in a single request. The request is considered successful if at least one order     in the batch is created — partial success returns HTTP 202 with details of each order's result.<br/>\n    The maximum batch size is: <strong>5</strong><br/>\n    Required API Key permissions: <strong>trade</strong></br></br>\n    <strong>Rate Limit:</strong> 8 requests per 2 seconds.","operationId":"create-batch","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreateBatchModel"}}}},"responses":{"202":{"description":"At least one creation was successfully executed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBatchResponse"}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"422":{"description":"No creation has been successfully executed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBatchResponseError"}}}}},"summary":"Create orders in batch","tags":["Trading"]}},"/rest/v3/orders/cancel-replace":{"post":{"description":"Cancel an existing order and create a new one in a single request, e.g. to change its price or       quantity. Both are sent at the same time and each can fail on its own, so this is not atomic: the       order may still fill before the cancel takes effect. The response reports the result of each       operation; when both fail, the API answers 422.<br/>      Required API Key permissions: <strong>trade</strong></br></br>      <strong>Rate Limit:</strong> 20 requests per 2 seconds.","operationId":"cancel-replace","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelReplace"}}}},"responses":{"202":{"description":"At least one operation was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCanceledReplaced"},"example":{"cancel":{"id":"123456789"},"create":{"id":"1234567891","client_order_id":"451637946502"}}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"422":{"description":"Both operations were not successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelReplaceError"}}}}},"summary":"Cancel and replace","tags":["Trading"]}},"/rest/v3/orders/{order_sn}":{"get":{"deprecated":true,"description":"Get an order by serial number.<br/>      <strong>This endpoint is deprecated</strong> — use the       <a href=\"#tag/Trading/operation/get-order-by-id\">Get an order by ID</a> endpoint instead","operationId":"get-order-by-sn","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"order_sn","required":true,"in":"path","description":"Order serial number","schema":{"example":"OQMPZNKZPFTKCS","type":"string"}}],"responses":{"200":{"description":"Order was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWithoutRemark"},"example":{"id":"1234567890","sn":"OQMPZNKZPFTKCS","client_order_id":"451637946501","market_symbol":"btcbrl","side":"BUY","type":"LIMIT","state":"ACTIVE","price":"290000.0","price_avg":"0.0","quantity":"0.42","quantity_executed":"0.0","instant_amount":null,"instant_amount_executed":null,"created_at":"2021-02-15T22:06:32.999Z","trades_count":0,"fee_paid":"0.0","post_only":false,"time_in_force":"GTC","cancellation_reason":null,"cancellation_reason_order_id":null,"stp":"EXPIRE_TAKER","slippage_tolerance":"0.025"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Order not found"}},"summary":"Get an order by SN","tags":["Trading"]}},"/rest/v3/orders/by-order-id/{id}":{"get":{"description":"Retrieve detailed information about a specific order by its ID, a numeric value sent as a string, including current state,       price, quantity, executed amounts, fees and cancellation reason when applicable.</br></br>      <strong>Rate Limit:</strong> 30 requests per 2 seconds.","operationId":"get-order-by-id","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"example":"1234567890","type":"string"}},{"name":"sub_account_type","required":false,"in":"query","description":"The sub-account type to search the order","schema":{"type":"string","enum":["PREDICTION"]}}],"responses":{"200":{"description":"Order was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"example":{"id":"1234567890","sn":"OKMAKSDHRVVREK","client_order_id":"451637946501","market_symbol":"btcbrl","side":"BUY","type":"LIMIT","state":"ACTIVE","price":"290000.0","price_avg":"0.0","quantity":"0.42","quantity_executed":"0.0","instant_amount":null,"instant_amount_executed":null,"created_at":"2021-02-15T22:06:32.999Z","trades_count":0,"fee_paid":"0.0","post_only":false,"time_in_force":"GTC","cancellation_reason":null,"cancellation_reason_order_id":null,"stp":"EXPIRE_TAKER","slippage_tolerance":"0.025","remark":"A remarkable note for the order."}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Order not found"}},"summary":"Get an order by ID","tags":["Trading"]}},"/rest/v3/orders/by-client-order-id/{client_order_id}":{"get":{"description":"Retrieve detailed information about a specific order using the client-provided numeric identifier       (max. of 2^63 - 1, sent as a string of digits) that was assigned at order creation time. Returns the same data as the       <a href=\"#tag/Trading/operation/get-order-by-id\">Get an order by ID</a> endpoint.</br></br>      <strong>Rate Limit:</strong> 30 requests per 2 seconds.","operationId":"get-order-by-client-order-id","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"client_order_id","required":true,"in":"path","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as digits","schema":{"type":"string","example":"57354679787653765"}},{"name":"sub_account_type","required":false,"in":"query","description":"The sub-account type to search the order","schema":{"type":"string","enum":["PREDICTION"]}}],"responses":{"200":{"description":"Order was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"example":{"id":"1234567890","sn":"OKMAKSDHRVVREK","client_order_id":"57354679787653765","market_symbol":"btcbrl","side":"BUY","type":"LIMIT","state":"ACTIVE","price":"290000.0","price_avg":"0.0","quantity":"0.42","quantity_executed":"0.0","instant_amount":null,"instant_amount_executed":null,"created_at":"2021-02-15T22:06:32.999Z","trades_count":0,"fee_paid":"0.0","post_only":false,"time_in_force":"GTC","cancellation_reason":null,"cancellation_reason_order_id":null,"stp":"EXPIRE_TAKER","slippage_tolerance":"0.025","remark":null}}}},"400":{"description":"client_order_id is not an integer between 0 and 9223372036854775807"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Order not found"}},"summary":"Get an order by client ID","tags":["Trading"]}},"/rest/v3/orders/cancel":{"put":{"description":"Cancel one or more orders based on the specified criteria. You can cancel by order ID, SN, client order ID,       market, market+side, or cancel all open orders at once — see the request body schema for each option.</br>      Order cancellation is <strong>asynchronous</strong>, so it usually takes some milliseconds to process.       Use the <a href=\"#tag/Trading/operation/get-order-by-id\">Get an order by ID</a> endpoint to confirm the final state.</br></br>      Required API Key permissions: <strong>trade</strong></br></br>      <strong>Rate Limit:</strong> 30 requests per 2 seconds.","operationId":"cancel-orders","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrdersRequest"}}}},"responses":{"200":{"description":"A list of order SNs and Ids sent to the cancellation queue was returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersCanceled"}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."}},"summary":"Cancel orders","tags":["Trading"]}},"/rest/v3/trades":{"get":{"description":"Retrieve a paginated list of the authenticated member's executed trades. Each trade includes price, quantity,       fee, fee currency, role (maker/taker) and the associated order ID. Results are returned in descending order       (most recent first).</br>      Trade history is available for the <strong>last 3 months</strong> only.       Contact support for longer historical data.</br></br>      <strong>Cache:</strong> 10 seconds.</br>      <strong>Rate Limit:</strong> 5 requests per 1 second.","operationId":"list-trades","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"market_symbol","required":true,"in":"query","description":"Market symbol to filter by","schema":{"example":"btcbrl","type":"string"}},{"name":"order_id","required":false,"in":"query","description":"The specific order ID identification you want to filter","schema":{"example":"123456789","type":"string"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-01T22:06:32.999Z","type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-18T22:06:32.999Z","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","examples":{"first":{"value":1,"summary":"First page"},"tenth":{"value":10,"summary":"Tenth page"}},"schema":{"minimum":1,"default":1,"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned, maximum of 100","examples":{"default":{"value":50,"summary":"Default page size"},"max":{"value":100,"summary":"Maximum allowed"}},"schema":{"minimum":1,"maximum":100,"default":50,"type":"integer"}}],"responses":{"200":{"description":"A list of trades was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trades"}}}},"400":{"description":"Invalid or missing query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List trades","tags":["Trading"]}},"/rest/v3/system/time":{"get":{"description":"Returns the API server time in both ISO-8601 and UNIX Timestamp (milliseconds) formats.       Use this endpoint to synchronize your local clock with the server, which is required for generating       valid request signatures (see <a href=\"#tag/Authentication\">Authentication</a>).</br></br>      <strong>Rate Limit:</strong> 5 requests per 1 second.","operationId":"get-current-time","parameters":[],"responses":{"200":{"description":"Server time was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemTime"}}}}},"summary":"Get current time","tags":["System"]}},"/rest/v3/accounts":{"get":{"description":"Retrieve all currency balances for the authenticated member. Each account entry includes the total balance,       the available balance (funds ready for trading or withdrawal) and the locked balance       (funds reserved by open orders or pending withdrawals).</br></br>      <strong>Rate Limit:</strong> 15 requests per 1 second.","operationId":"list-accounts","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"sub_account_type","required":false,"in":"query","description":"The sub-account type to filter accounts","schema":{"type":"string","enum":["PREDICTION"]}}],"responses":{"200":{"description":"A list of member accounts was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"Get member accounts","tags":["Account"]}},"/rest/v3/accounts/{currency_symbol}/transactions":{"get":{"description":"Retrieve all account movements for a specific currency. Transactions represent every balance change,       including trades, deposits, withdrawals and internal transfers. Each entry shows the amount,       resulting balance, locked amount and fee, making it possible to reconstruct the full balance history.</br>      The maximum time range is <strong>3 months</strong>. Older transactions will not be retrieved.       Contact support for longer historical data.</br></br>      <strong>Rate Limit:</strong> 1 request per 2 seconds.","operationId":"get-transactions","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-01T22:06:32.999Z","type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, must be in ISO-8601 UTC. The range between start_time and end_time is limited to 90 days","schema":{"example":"2022-02-18T22:06:32.999Z","type":"string"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned, maximum of 100","schema":{"minimum":1,"maximum":100,"default":10,"example":10,"type":"integer"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","schema":{"minimum":1,"default":1,"example":1,"type":"integer"}},{"name":"currency_symbol","required":true,"in":"path","schema":{"example":"btc","type":"string"}}],"responses":{"200":{"description":"The transactions were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsResponse"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"Get member transactions","tags":["Account"]}},"/rest/v3/deposits":{"get":{"description":"Retrieve a paginated list of all deposit transactions for the authenticated member,       including both cryptocurrency and fiat deposits. Supports filtering by date range.</br></br>      <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"list-deposits","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, must be in ISO-8601 UTC","schema":{"example":"2022-02-01T22:06:32.999Z","type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, must be in ISO-8601 UTC","schema":{"example":"2022-02-18T22:06:32.999Z","type":"string"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned, maximum of 100","schema":{"minimum":1,"maximum":100,"default":10,"example":10,"type":"integer"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","schema":{"minimum":1,"default":1,"example":1,"type":"integer"}}],"responses":{"200":{"description":"A list of deposits was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deposits"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List deposits","tags":["Deposit"]}},"/rest/v3/deposits/{deposit_sn}":{"get":{"description":"Retrieve detailed information about a specific deposit by its unique serial number (SN),       including state, amount, fee and cryptocurrency transaction details when applicable.</br></br>      A crypto deposit in <code>AWAITING_TRAVEL_RULE</code> waits for its Travel Rule declaration: see the       <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a>.</br></br>      <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"find-deposit-by-sn","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"deposit_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the deposit","schema":{"example":"DPKXMRDT7H4VBN","type":"string"}}],"responses":{"200":{"description":"Deposit was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deposit"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Deposit not found"}},"summary":"Get a deposit","tags":["Deposit"]}},"/rest/v3/deposits/{deposit_sn}/travel_rule":{"post":{"description":"Declares the Travel Rule of a crypto deposit: who holds the origin wallet and, for a third party, who sends the funds.</br></br><strong>Step 5 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a>.</br></br><strong>Before calling.</strong> The deposit must be in <code>AWAITING_TRAVEL_RULE</code> with <code>travel_rule</code> <code>null</code> (read it with <a href=\"#tag/Deposit/operation/find-deposit-by-sn\"><code>GET /deposits/{deposit_sn}</code></a>). Take the countries from <a href=\"#tag/Travel-Rule/operation/list-travel-rule-countries\"><code>GET /travel_rule/countries</code></a> and, when the declaration asks for <code>operation_reason</code>, the purpose from <a href=\"#tag/Deposit/operation/list-deposit-travel-rule-operation-reasons\"><code>GET /deposits/{deposit_sn}/travel_rule/operation_reasons</code></a>.</br></br><div style=\"border-left: 4px solid #1f6feb; background-color: #eef4ff; color: #1f1f1f; padding: 12px 16px; margin: 0 0 16px; border-radius: 4px;\">&#128216; <strong>Before filling this body, read the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a></strong><br/><strong>Step 2</strong>: which variant to send<br/><strong>Step 3</strong>: the fields each path asks<br/><strong>Step 4</strong>: the countries and the purpose<br/><strong>Step 5</strong>: every error and its code<br/><strong>Step 7</strong>: what each answer means</div>\n\n<strong>Body.</strong> <code>wallet_owner</code> and <code>wallet_type</code> pick one of four variants (<code>DepositTravelRuleOwnPrivateWallet</code>, <code>DepositTravelRuleOwnExchangeWallet</code>, <code>DepositTravelRuleThirdPartyPrivateWallet</code>, <code>DepositTravelRuleThirdPartyExchangeWallet</code>); each lists its fields and when its path asks them, and someone else goes under <code>sender</code>. Send only the fields of your variant, with the names and the shape the deposit read returns in <code>travel_rule</code>.</br></br><strong>Outcome.</strong> The answer brings the new <code>state</code> and <code>documents_required</code>: credited (<code>ACCEPTED</code>), held for the documents listed in <code>travel_rule.required_documents</code> (send them with <a href=\"#tag/Deposit/operation/create-deposit-travel-rule-documents\"><code>POST /deposits/{deposit_sn}/travel_rule/documents</code></a>) or under review (<code>AWAITING_TRAVEL_RULE_REVIEW</code>). A deposit is never canceled while it waits.</br></br>Required API Key permissions: <strong>deposit</strong></br></br><strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"create-deposit-travel-rule","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"deposit_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the deposit","schema":{"example":"DPKXMRDT7H4VBN","type":"string"}}],"requestBody":{"required":true,"description":"One of the variants below, picked by `wallet_owner` and `wallet_type`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTravelRuleDeclarationRequest"},"examples":{"own_private_wallet":{"summary":"Own private wallet","value":{"wallet_owner":"SELF","wallet_type":"SELF_HOSTED","purpose_description":"Moving my own funds"}},"own_exchange_in_brazil":{"summary":"Own account at an Exchange/VASP in Brazil","value":{"wallet_owner":"SELF","wallet_type":"HOSTED","vasp_name":"Example Exchange","vasp_entity_country":"BR"}},"own_exchange_abroad":{"summary":"Own account at an Exchange/VASP abroad","value":{"wallet_owner":"SELF","wallet_type":"HOSTED","vasp_name":"Example Exchange","vasp_entity_country":"US","purpose_description":"Moving my own funds","operation_reason":"32999"}},"third_party_private_wallet_in_brazil":{"summary":"Third-party private wallet, sender in Brazil","value":{"wallet_owner":"THIRD_PARTY","wallet_type":"SELF_HOSTED","sender":{"person_type":"NATURAL","name":"Jane Doe","tax_id_number":"52998224725","residence_country":"BR"},"purpose_description":"Payment for consulting services"}},"third_party_exchange_company_abroad":{"summary":"Third-party Exchange/VASP account, company sender abroad (company account)","value":{"wallet_owner":"THIRD_PARTY","wallet_type":"HOSTED","vasp_name":"Example Exchange","vasp_entity_country":"US","sender":{"person_type":"LEGAL","name":"Example Company LLC","tax_id_number":"123456789","residence_country":"US","entity_category":"05"},"same_economic_group":false,"purpose_description":"Payment for consulting services","operation_reason":"32999"}}}}}},"responses":{"201":{"description":"Travel Rule submitted. Returns the deposit state, the outcome and the persisted declaration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTravelRuleSubmitted"}}}},"400":{"description":"Invalid body — a field missing, not accepted or malformed for the path the body describes; `details` lists every one, naming the field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TravelRuleDeclarationErrorResponse"},"examples":{"missing_fields":{"summary":"Fields the path asks are missing","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_name is required for this declaration","vasp_entity_country is required for this declaration"]}}},"field_outside_variant":{"summary":"A field the variant does not have","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_name is not part of this declaration variant"]}}},"malformed_field":{"summary":"A malformed field","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_entity_country must be an uppercase ISO 3166-1 alpha-2 country code"]}}}}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Deposit not found"},"422":{"description":"Travel Rule validation error — the deposit is not held for the Travel Rule or was already declared, or a field your account type requires is missing or one it does not accept was sent (the detail names it)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TravelRuleDeclarationErrorResponse"},"examples":{"not_held":{"summary":"Not held for the Travel Rule","value":{"error":{"message":"Unprocessable entity.","code":422,"details":["The deposit is not held for the Travel Rule (state: ACCEPTED)"]}}},"already_declared":{"summary":"Already declared","value":{"error":{"message":"Unprocessable entity.","code":422,"details":["The Travel Rule declaration of this deposit was already submitted"]}}},"purpose_above_threshold":{"summary":"The purpose description, required above USD 50,000","value":{"error":{"message":"Validation error.","code":4001,"details":["purpose_description is required for this declaration"]}}},"not_for_account_type":{"summary":"A field the account type does not take","value":{"error":{"message":"Validation error.","code":4001,"details":["entity_category does not apply to this declaration"]}}}}}}}},"summary":"Submit Travel Rule for a deposit","tags":["Deposit"]}},"/rest/v3/deposits/{deposit_sn}/travel_rule/operation_reasons":{"get":{"description":"Lists the BACEN operation reasons (purposes) the Travel Rule declaration of the deposit accepts.</br></br><strong>Step 4 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a> (only when the declaration asks for operation_reason).</br></br><strong>When to call.</strong> When the declaration asks for <code>operation_reason</code>: an Exchange/VASP or a sender abroad, or a client resident abroad (<code>fx_residence_country</code> other than <code>BR</code>). The deposit must be in <code>AWAITING_TRAVEL_RULE</code> with <code>travel_rule</code> <code>null</code> (read it with <a href=\"#tag/Deposit/operation/find-deposit-by-sn\"><code>GET /deposits/{deposit_sn}</code></a>).</br></br><strong>Then.</strong> Send the chosen <code>code</code> as <code>operation_reason</code> to <a href=\"#tag/Deposit/operation/create-deposit-travel-rule\"><code>POST /deposits/{deposit_sn}/travel_rule</code></a>. When the purpose has <code>required_documents</code>, those files go to <a href=\"#tag/Deposit/operation/create-deposit-travel-rule-documents\"><code>POST /deposits/{deposit_sn}/travel_rule/documents</code></a> after the declaration, which lists them again. If the declaration refuses the purpose, call this route again and pick one of the purposes it returns.</br></br>Required API Key permissions: <strong>deposit</strong></br></br><strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"list-deposit-travel-rule-operation-reasons","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"deposit_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the deposit","schema":{"example":"DPKXMRDT7H4VBN","type":"string"}},{"name":"Locale","in":"header","description":"Language used to localize the operation reason <code>description</code> field.     Accepted values (case-sensitive): <code>EN</code>, <code>PT-BR</code>. Defaults to <code>EN</code>     when the header is omitted. Any other value (including lowercase variants such as     <code>en</code> or <code>pt-BR</code>) causes the request to fail with     <strong>400 Bad Request</strong>.","required":false,"schema":{"type":"string","enum":["EN","PT-BR"],"default":"EN"}}],"responses":{"200":{"description":"The operation reasons of the deposit were retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTravelRuleOperationReasons"}}}},"400":{"description":"Unsupported Locale"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Deposit not found, or no operation reason is available for it"},"422":{"description":"The deposit is not held in `AWAITING_TRAVEL_RULE` waiting for its declaration"}},"summary":"List the Travel Rule operation reasons of a deposit","tags":["Deposit"]}},"/rest/v3/deposits/address":{"get":{"description":"Retrieve an existing deposit address for a specific cryptocurrency and network, or schedule the creation of a new one       if none exists yet. When an address is being generated, retry the request after a few minutes.</br></br>      <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"get-deposit-address","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"network_code","required":false,"in":"query","description":"Wallet network. To see the deposit networks available for each currency, \n    check our <a href=\"https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/list-currencies\">currencies list</a> endpoint","schema":{"example":"bitcoin","type":"string"}},{"name":"currency_symbol","required":true,"in":"query","description":"Currency symbol","schema":{"example":"btc","type":"string"}}],"responses":{"200":{"description":"A deposit address for the given currency was retrieved successfully. While it is being       created, `address`, `currency_symbol` and `network` are null and `message` asks to retry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositAddress"}}}},"400":{"description":"currency_symbol must be a string"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Currency not found or not available"}},"summary":"Get a deposit address","tags":["Deposit"]}},"/rest/v3/deposits/{deposit_sn}/travel_rule/documents":{"post":{"description":"Sends the documents the Travel Rule purpose of the deposit requires.</br></br><strong>Step 6 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a> (only when the declaration asks for them).</br></br><strong>When to call.</strong> After <a href=\"#tag/Deposit/operation/create-deposit-travel-rule\"><code>POST /deposits/{deposit_sn}/travel_rule</code></a> answered <code>documents_required</code> <code>true</code>: the deposit stays in <code>AWAITING_TRAVEL_RULE</code> until the files arrive. Which files to send is <code>travel_rule.required_documents</code> in the declaration answer, and <code>travel_rule.required_documents</code> in <a href=\"#tag/Deposit/operation/find-deposit-by-sn\"><code>GET /deposits/{deposit_sn}</code></a>.</br></br><strong>Files.</strong> <code>pdf</code>, <code>jpg</code>, <code>jpeg</code>, <code>png</code>, <code>csv</code>, <code>xls</code>, <code>xlsx</code>; up to 20 files and 25MB per request.</br></br><strong>Send the whole set in one request.</strong> The first request moves the deposit on — to review, or it is credited — and a later request is refused. Nothing is stored when the deposit is not waiting for documents.</br></br><strong>Then.</strong> Follow the deposit with <a href=\"#tag/Deposit/operation/find-deposit-by-sn\"><code>GET /deposits/{deposit_sn}</code></a>.</br></br>Required API Key permissions: <strong>deposit</strong></br></br><strong>Rate Limit:</strong> 2 requests per 10 seconds.","operationId":"create-deposit-travel-rule-documents","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"deposit_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the deposit","schema":{"example":"DPKXMRDT7H4VBN","type":"string"}},{"name":"X-FB-CONTENT-SHA256","in":"header","description":"Hex SHA-256 that replaces the body in the signature prehash (recomputed server-side to guarantee file integrity).<br/>Compute it over the concatenation of the raw bytes of every <code>files</code> part, in the order they are sent.<br/>Example: <code>sha256(file1_bytes + file2_bytes)</code>.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["files"],"properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"The documents requested for the chosen purpose"}}}}}},"responses":{"201":{"description":"Documents attached to the request and the deposit moved on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTravelRuleDocumentsSubmitted"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Deposit not found"},"415":{"description":"Request body is not multipart/form-data"},"422":{"description":"The deposit is not held for the Travel Rule or owes no documents for its declaration, invalid file extension or size, more than 20 files, no file sent, or a digest mismatch"},"502":{"description":"The documents could not be stored; retry later"}},"summary":"Send the Travel Rule documents of a deposit","tags":["Deposit"]}},"/rest/v3/withdrawals":{"get":{"description":"Retrieve a paginated list of all withdrawal transactions for the authenticated member,       including both cryptocurrency and fiat withdrawals. Supports filtering by date range.</br></br>      <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"list-withdrawals","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"start_time","required":false,"in":"query","description":"Filter values after this start_time, must be in ISO-8601 UTC","schema":{"example":"2022-02-01T22:06:32.999Z","type":"string"}},{"name":"end_time","required":false,"in":"query","description":"Filter values before this end_time, must be in ISO-8601 UTC","schema":{"example":"2022-02-18T22:06:32.999Z","type":"string"}},{"name":"page_size","required":false,"in":"query","description":"The number of entries returned, maximum of 100","schema":{"minimum":1,"maximum":100,"default":10,"example":10,"type":"integer"}},{"name":"page","required":false,"in":"query","description":"Page to be retrieved from the list","schema":{"minimum":1,"default":1,"example":1,"type":"integer"}}],"responses":{"200":{"description":"A list of withdrawals was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdrawals"},"example":{"data":[{"sn":"WDRZN4HKGT8MBP","state":"DONE","rejection_reason":null,"currency_symbol":"btc","amount":"0.5","fee":"0.0001","created_at":"2022-02-18T22:06:32.999Z","details_crypto":{"transaction_id":"ed05d4b4d3369f4768ea7bc1c28a762ccd2ebe50f4eb41f41d49c71a6064273c","destination_address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","destination_tag":null,"network_code":"bitcoin"}},{"sn":"WXET64IVAH5HN2","state":"DONE","rejection_reason":null,"currency_symbol":"brl","amount":"100.0","fee":"0.0","created_at":"2022-02-17T13:09:27.261Z","details_fiat":{"bank":{"code":"341","branch":{"number":"1234","digit":null},"account":{"number":"12345","digit":"6","type":"CHECK"}}}}]}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List withdrawals","tags":["Withdrawal"]},"post":{"description":"Submit a new withdrawal request for cryptocurrency or fiat currency.     The request body differs based on the currency type — see the schema options below.</br></br>\n    For <strong>cryptocurrency withdrawals</strong>, we highly recommend adding your withdrawal     address to our whitelist for a seamless and automated process. While not mandatory,     non-whitelisted addresses require an email verification and proof of life for each withdrawal,     which may delay transactions.</br>\n    To whitelist an address, open a support ticket     <a href=\"https://faq.foxbit.com.br/hc/pt-br/requests/new\" target=\"_blank\">here</a>.</br></br>\n    <strong>Travel Rule:</strong> once confirmed, a crypto withdrawal may be held in     <code>AWAITING_TRAVEL_RULE</code> until you declare it — see the     <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a>.</br></br>\n    Required API Key permissions: <strong>withdraw</strong></br></br>\n    <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"create-withdrawal","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWithdrawalRequest"}}}},"responses":{"201":{"description":"A withdrawal was created successfully. `details_fiat` is set for fiat withdrawals and       `details_crypto` for crypto ones","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalCreated"},"example":{"sn":"WBZYUBF73C4GUU","state":"SUBMITTED","currency_symbol":"btc","amount":"0.5","fee":"0.0001","created_at":"2022-09-15T12:38:18.510Z","details_crypto":{"transaction_id":null,"destination_address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","destination_tag":null}}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"422":{"description":"Validation error, e.g. an invalid destination address"}},"summary":"Create a withdrawal","tags":["Withdrawal"]}},"/rest/v3/withdrawals/{withdrawal_sn}":{"get":{"description":"Retrieve detailed information about a specific withdrawal by its unique serial number (SN),       including state, amount, fee, rejection reason (if any) and transaction details       (crypto hash or bank account data).</br></br>      A crypto withdrawal in <code>AWAITING_TRAVEL_RULE</code> waits for its Travel Rule declaration: see the       <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a>.</br></br>      <strong>Rate Limit:</strong> 3 requests per 1 second.","operationId":"find-withdrawals-by-sn","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"withdrawal_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the withdrawal","schema":{"example":"WDRZN4HKGT8MBP","type":"string"}}],"responses":{"200":{"description":"A withdrawal was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdrawal"},"example":{"sn":"WDRZN4HKGT8MBP","state":"DONE","rejection_reason":null,"currency_symbol":"btc","amount":"0.5","fee":"0.0001","created_at":"2022-02-18T22:06:32.999Z","details_crypto":{"transaction_id":"ed05d4b4d3369f4768ea7bc1c28a762ccd2ebe50f4eb41f41d49c71a6064273c","destination_address":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","destination_tag":null,"network_code":"bitcoin"}}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Withdrawal not found"}},"summary":"Get a withdrawal","tags":["Withdrawal"]}},"/rest/v3/withdrawals/{withdrawal_sn}/travel_rule":{"post":{"description":"Declares the Travel Rule of a crypto withdrawal: who holds the destination wallet and, for a third party, who receives the funds.</br></br><strong>Step 5 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a>.</br></br><strong>Before calling.</strong> The withdrawal must be in <code>AWAITING_TRAVEL_RULE</code> with <code>travel_rule</code> <code>null</code> (read it with <a href=\"#tag/Withdrawal/operation/find-withdrawals-by-sn\"><code>GET /withdrawals/{withdrawal_sn}</code></a>). Take the countries from <a href=\"#tag/Travel-Rule/operation/list-travel-rule-countries\"><code>GET /travel_rule/countries</code></a> and, when the declaration asks for <code>operation_reason</code>, the purpose from <a href=\"#tag/Withdrawal/operation/list-withdrawal-travel-rule-operation-reasons\"><code>GET /withdrawals/{withdrawal_sn}/travel_rule/operation_reasons</code></a>.</br></br><div style=\"border-left: 4px solid #1f6feb; background-color: #eef4ff; color: #1f1f1f; padding: 12px 16px; margin: 0 0 16px; border-radius: 4px;\">&#128216; <strong>Before filling this body, read the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a></strong><br/><strong>Step 2</strong>: which variant to send<br/><strong>Step 3</strong>: the fields each path asks<br/><strong>Step 4</strong>: the countries and the purpose<br/><strong>Step 5</strong>: every error and its code<br/><strong>Step 7</strong>: what each answer means</div>\n\n<strong>Body.</strong> <code>wallet_owner</code> and <code>wallet_type</code> pick one of four variants (<code>WithdrawalTravelRuleOwnPrivateWallet</code>, <code>WithdrawalTravelRuleOwnExchangeWallet</code>, <code>WithdrawalTravelRuleThirdPartyPrivateWallet</code>, <code>WithdrawalTravelRuleThirdPartyExchangeWallet</code>); each lists its fields and when its path asks them, and someone else goes under <code>recipient</code>. Send only the fields of your variant, with the names and the shape the withdrawal read returns in <code>travel_rule</code>.</br></br><strong>Outcome.</strong> The answer brings the new <code>state</code> and <code>documents_required</code>: released (<code>PROCESSING</code>), held for the documents listed in <code>travel_rule.required_documents</code> (send them with <a href=\"#tag/Withdrawal/operation/create-withdrawal-travel-rule-documents\"><code>POST /withdrawals/{withdrawal_sn}/travel_rule/documents</code></a>), under review (<code>AWAITING_TRAVEL_RULE_REVIEW</code>), or refused with <code>422</code> and <code>REJECTED</code>, with the funds returned. A withdrawal whose declaration or documents are still missing 24 hours after being asked is <code>CANCELED</code>, with the funds returned; the 24 hours restart each time a step is asked again and stop during the review. A withdrawal that went back from <code>AWAITING_TRAVEL_RULE_REVIEW</code> to <code>AWAITING_TRAVEL_RULE</code> has no deadline.</br></br>Required API Key permissions: <strong>withdraw</strong></br></br><strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"create-withdrawal-travel-rule","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"withdrawal_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the withdrawal","schema":{"example":"WDRZN4HKGT8MBP","type":"string"}}],"requestBody":{"required":true,"description":"One of the variants below, picked by `wallet_owner` and `wallet_type`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalTravelRuleDeclarationRequest"},"examples":{"own_private_wallet":{"summary":"Own private wallet","value":{"wallet_owner":"SELF","wallet_type":"SELF_HOSTED","purpose_description":"Moving to my own wallet"}},"own_exchange_in_brazil":{"summary":"Own account at an Exchange/VASP in Brazil","value":{"wallet_owner":"SELF","wallet_type":"HOSTED","vasp_name":"Example Exchange","vasp_entity_country":"BR"}},"own_exchange_abroad":{"summary":"Own account at an Exchange/VASP abroad","value":{"wallet_owner":"SELF","wallet_type":"HOSTED","vasp_name":"Example Exchange","vasp_entity_country":"US","purpose_description":"Moving to my own account","operation_reason":"32999"}},"third_party_private_wallet_abroad":{"summary":"Third-party private wallet, recipient abroad","value":{"wallet_owner":"THIRD_PARTY","wallet_type":"SELF_HOSTED","recipient":{"person_type":"NATURAL","name":"Jane Doe","tax_id_number":"123456789","residence_country":"US"},"purpose_description":"Gift to a relative","operation_reason":"32999"}},"third_party_exchange_in_brazil":{"summary":"Third-party Exchange/VASP account, recipient in Brazil","value":{"wallet_owner":"THIRD_PARTY","wallet_type":"HOSTED","vasp_name":"Example Exchange","recipient":{"person_type":"NATURAL","name":"Jane Doe","tax_id_number":"52998224725","residence_country":"BR"}}}}}}},"responses":{"201":{"description":"Travel Rule submitted. Returns the withdrawal state, the outcome and the persisted declaration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalTravelRuleSubmitted"}}}},"400":{"description":"Invalid body — a field missing, not accepted or malformed for the path the body describes; `details` lists every one, naming the field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TravelRuleDeclarationErrorResponse"},"examples":{"missing_fields":{"summary":"Fields the path asks are missing","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_name is required for this declaration","vasp_entity_country is required for this declaration"]}}},"field_outside_variant":{"summary":"A field the variant does not have","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_name is not part of this declaration variant"]}}},"malformed_field":{"summary":"A malformed field","value":{"error":{"message":"Bad request.","code":400,"details":["vasp_entity_country must be an uppercase ISO 3166-1 alpha-2 country code"]}}}}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Withdrawal not found"},"422":{"description":"Travel Rule validation error — the withdrawal is not held for the Travel Rule, a field your account type requires is missing or one it does not accept was sent, or the declaration rejected the withdrawal (its `rejection_reason` says why)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TravelRuleDeclarationErrorResponse"},"examples":{"not_held":{"summary":"Not held for the Travel Rule","value":{"error":{"message":"Unprocessable entity.","code":422,"details":["The withdrawal is not held for the Travel Rule (state: PROCESSING)"]}}},"purpose_above_threshold":{"summary":"The purpose description, required above USD 50,000","value":{"error":{"message":"Validation error.","code":4001,"details":["purpose_description is required for this declaration"]}}},"not_for_account_type":{"summary":"A field the account type does not take","value":{"error":{"message":"Validation error.","code":4001,"details":["entity_category does not apply to this declaration"]}}}}}}}},"summary":"Submit Travel Rule for a withdrawal","tags":["Withdrawal"]}},"/rest/v3/withdrawals/{withdrawal_sn}/travel_rule/operation_reasons":{"get":{"description":"Lists the BACEN operation reasons (purposes) the Travel Rule declaration of the withdrawal accepts.</br></br><strong>Step 4 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a> (only when the declaration asks for operation_reason).</br></br><strong>When to call.</strong> When the declaration asks for <code>operation_reason</code>: an Exchange/VASP or a recipient abroad, or a client resident abroad (<code>fx_residence_country</code> other than <code>BR</code>). The withdrawal must be in <code>AWAITING_TRAVEL_RULE</code> with <code>travel_rule</code> <code>null</code> (read it with <a href=\"#tag/Withdrawal/operation/find-withdrawals-by-sn\"><code>GET /withdrawals/{withdrawal_sn}</code></a>).</br></br><strong>Then.</strong> Send the chosen <code>code</code> as <code>operation_reason</code> to <a href=\"#tag/Withdrawal/operation/create-withdrawal-travel-rule\"><code>POST /withdrawals/{withdrawal_sn}/travel_rule</code></a>. When the purpose has <code>required_documents</code>, those files go to <a href=\"#tag/Withdrawal/operation/create-withdrawal-travel-rule-documents\"><code>POST /withdrawals/{withdrawal_sn}/travel_rule/documents</code></a> after the declaration, which lists them again. If the declaration refuses the purpose, call this route again and pick one of the purposes it returns.</br></br>Required API Key permissions: <strong>withdraw</strong></br></br><strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"list-withdrawal-travel-rule-operation-reasons","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"withdrawal_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the withdrawal","schema":{"example":"WDRZN4HKGT8MBP","type":"string"}},{"name":"Locale","in":"header","description":"Language used to localize the operation reason <code>description</code> field.     Accepted values (case-sensitive): <code>EN</code>, <code>PT-BR</code>. Defaults to <code>EN</code>     when the header is omitted. Any other value (including lowercase variants such as     <code>en</code> or <code>pt-BR</code>) causes the request to fail with     <strong>400 Bad Request</strong>.","required":false,"schema":{"type":"string","enum":["EN","PT-BR"],"default":"EN"}}],"responses":{"200":{"description":"The operation reasons of the withdrawal were retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalTravelRuleOperationReasons"}}}},"400":{"description":"Unsupported Locale"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Withdrawal not found, or no operation reason is available for it"},"422":{"description":"The withdrawal is not held in `AWAITING_TRAVEL_RULE`"}},"summary":"List the Travel Rule operation reasons of a withdrawal","tags":["Withdrawal"]}},"/rest/v3/withdrawals/{withdrawal_sn}/travel_rule/documents":{"post":{"description":"Sends the documents the Travel Rule purpose of the withdrawal requires.</br></br><strong>Step 6 of 7</strong> of the <a href=\"#tag/Tutorials/How-to-declare-the-Travel-Rule\">step-by-step guide</a> (only when the declaration asks for them).</br></br><strong>When to call.</strong> After <a href=\"#tag/Withdrawal/operation/create-withdrawal-travel-rule\"><code>POST /withdrawals/{withdrawal_sn}/travel_rule</code></a> answered <code>documents_required</code> <code>true</code>: the withdrawal stays in <code>AWAITING_TRAVEL_RULE</code> until the files arrive. Which files to send is <code>travel_rule.required_documents</code> in the declaration answer, and <code>travel_rule.required_documents</code> in <a href=\"#tag/Withdrawal/operation/find-withdrawals-by-sn\"><code>GET /withdrawals/{withdrawal_sn}</code></a>.</br></br><strong>Files.</strong> <code>pdf</code>, <code>jpg</code>, <code>jpeg</code>, <code>png</code>, <code>csv</code>, <code>xls</code>, <code>xlsx</code>; up to 20 files and 25MB per request.</br></br><strong>Send the whole set in one request.</strong> The first request moves the withdrawal on — to review, or it is released — and a later request is refused. Before the files are read, the withdrawal must be in <code>AWAITING_TRAVEL_RULE</code>; send them only after the declaration asked for them.</br></br><strong>Then.</strong> Follow the withdrawal with <a href=\"#tag/Withdrawal/operation/find-withdrawals-by-sn\"><code>GET /withdrawals/{withdrawal_sn}</code></a>.</br></br>Required API Key permissions: <strong>withdraw</strong></br></br><strong>Rate Limit:</strong> 2 requests per 10 seconds.","operationId":"create-withdrawal-travel-rule-documents","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"withdrawal_sn","required":true,"in":"path","description":"The alphanumeric unique identifier of the withdrawal","schema":{"example":"WDRZN4HKGT8MBP","type":"string"}},{"name":"X-FB-CONTENT-SHA256","in":"header","description":"Hex SHA-256 that replaces the body in the signature prehash (recomputed server-side to guarantee file integrity).<br/>Compute it over the concatenation of the raw bytes of every <code>files</code> part, in the order they are sent.<br/>Example: <code>sha256(file1_bytes + file2_bytes)</code>.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["files"],"properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"The documents requested for the chosen purpose"}}}}}},"responses":{"201":{"description":"Documents attached to the request and the withdrawal moved on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalTravelRuleDocumentsSubmitted"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"404":{"description":"Withdrawal not found"},"415":{"description":"Request body is not multipart/form-data"},"422":{"description":"The withdrawal is not held for the Travel Rule, invalid file extension or size, more than 20 files, no file sent, a digest mismatch, or the withdrawal has no open document request for its Travel Rule declaration"},"502":{"description":"The documents could not be stored; retry later"}},"summary":"Send the Travel Rule documents of a withdrawal","tags":["Withdrawal"]}},"/rest/v3/banks":{"get":{"description":"Retrieve a list of all supported Brazilian banks. This data includes bank name, abbreviation and code,       which can be used to validate bank account information when submitting fiat withdrawals.</br></br>      <strong>Cache:</strong> 5 minutes.</br>      <strong>Rate Limit:</strong> 1 request per 1 second.","operationId":"list-banks","parameters":[],"responses":{"200":{"description":"A list of banks was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Banks"}}}}},"summary":"List banks","tags":["Banks"]}},"/rest/v3/transactional_limits":{"get":{"description":"Retrieve the transactional limits for the authenticated member, broken down by currency.       Each entry shows the total allowed limit and the remaining available limit for both deposits       and withdrawals. Limits may vary based on the member's KYC verification level.</br></br>      <strong>Rate Limit:</strong> 1 request per 2 seconds.","operationId":"list-transaction-limits","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"responses":{"200":{"description":"The member transactional limits were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionalLimitsResponse"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Transactional limits not found or not available"}},"summary":"List Transactional Limits","tags":["Transactional Limits"]}},"/rest/v3/prime_desk/markets":{"get":{"description":"Retrieve the list of markets available for Prime Desk trading, including supported trading pairs       and their configurations.</br></br>      <strong>Rate Limit:</strong> 1 request per 2 seconds.","operationId":"list-prime-desk-markets","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"responses":{"200":{"description":"List of Prime Desk markets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketsResponseModel"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List markets","tags":["Prime Desk"]}},"/rest/v3/prime_desk/quote/request":{"post":{"description":"Request a quotation for a large trade at the best available price. The returned quote includes       the price, amounts and a time-limited quote ID that can be used to execute the trade via the       <a href=\"#tag/Prime-Desk/operation/execute-prime-desk-quote\">Execute quote</a> endpoint.</br></br>      <strong>Rate Limit:</strong> 5 requests per 10 seconds.","operationId":"request-prime-desk-quote","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"description":"Provide either `quantity` (value in base currency) or `amount` (value in quote currency) — never both","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForQuote"}}}},"responses":{"201":{"description":"Quote requested successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForQuoteResponseModel"}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"Request quote","tags":["Prime Desk"]}},"/rest/v3/prime_desk/quote/execute":{"post":{"description":"Execute a previously requested quotation by providing its quote ID. The quote must still be within       its validity window. Once executed, the trade is settled at the quoted price.</br>      Required API Key permissions: <strong>trade</strong></br></br>      <strong>Rate Limit:</strong> 5 requests per 10 seconds.","operationId":"execute-prime-desk-quote","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrimeDeskExecuteQuoteModel"}}}},"responses":{"201":{"description":"Quote created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteQuoteCreatedModel"}}}},"400":{"description":"Invalid payload"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"403":{"description":"Permission denied for this request."},"422":{"description":"The quote was not found or can no longer be executed"}},"summary":"Execute quote","tags":["Prime Desk"]}},"/rest/v3/prime_desk/executions":{"get":{"description":"Retrieve a paginated history of all executed Prime Desk quotes for the authenticated member,       including trade details, prices and timestamps.</br></br>      <strong>Rate Limit:</strong> 5 requests per 2 seconds.","operationId":"list-prime-desk-executions","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"page","required":false,"in":"query","description":"Page number. Default: 1","schema":{"default":1,"example":1,"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Page size. Default: 10; Max: 20","schema":{"minimum":1,"maximum":20,"default":10,"example":10,"type":"integer"}}],"responses":{"200":{"description":"List of executed quotes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrimeDeskExecutionHistoryModel"}}}},"400":{"description":"Invalid query parameters"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}}},"summary":"List executions","tags":["Prime Desk"]}},"/rest/v3/prime_desk/executions/{quote_id}":{"get":{"description":"Retrieve detailed information about a specific executed Prime Desk trade by its quote UUID,       including price, amounts, side and execution timestamp.</br></br>      <strong>Rate Limit:</strong> 6 requests per 2 seconds.","operationId":"find-prime-desk-quote-by-id","parameters":[{"name":"X-FB-ACCESS-TIMESTAMP","in":"header","description":"The current timestamp of your request.Must be in UNIX timestamp format, which represents the number ofmilliseconds since January 1, 1970 (the UNIX epoch UTC)","required":true,"schema":{"type":"string","default":"{{CURRENT_TIMESTAMP}}"}},{"name":"X-FB-ACCESS-KEY","in":"header","description":"The API key as a string","required":true,"schema":{"type":"string","default":"{{API_KEY}}"}},{"name":"X-FB-ACCESS-SIGNATURE","in":"header","description":"The hex-encoded signature. See details below for generating the signature.","required":true,"schema":{"type":"string","default":"{{CURRENT_SIGNATURE}}"}},{"name":"quote_id","required":true,"in":"path","description":"Generated quote UUID of the execution","schema":{"example":"b5f1b6b0-0e4c-4d0e-8b1d-3e0e2a0c3b9a","type":"string"}}],"responses":{"200":{"description":"Get an execution by quote ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrimeDeskExecutionHistoryData"},"example":{"quote_id":"b5f1b6b0-0e4c-4d0e-8b1d-3e0e2a0c3b9a","client_order_id":"0f80c9e2-1a5f-4f6b-9d3e-6a3a4e2c8f10","price":"350120.32","market_symbol":"btcbrl","quantity":"0.01","side":"BUY","status":"FILLED","created_at":"2020-12-09T14:56:55.000Z"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"},"examples":{"InvalidSignature":{"summary":"Invalid signature","value":{"error":{"message":"Invalid signature.","code":2002,"details":["The signature for this request is not valid."]}}},"InvalidApiKey":{"summary":"Invalid access key","value":{"error":{"message":"Invalid access key.","code":2003,"details":["Access key missing, invalid or not found."]}}},"InvalidTimestamp":{"summary":"Missing or unparseable timestamp","value":{"error":{"message":"Invalid timestamp.","code":2004,"details":["Invalid or missing timestamp."]}}},"TimestampOutOfWindow":{"summary":"Timestamp out of window","value":{"error":{"message":"Timestamp out of window.","code":2006,"details":["The request timestamp is outside the allowed window. Check the client clock."]}}}}}}},"404":{"description":"Execution not found"}},"summary":"Get an execution by quote ID","tags":["Prime Desk"]}},"/rest/v3/travel_rule/countries":{"get":{"description":"Lists the ISO 3166-1 alpha-2 countries a Travel Rule declaration accepts, with the name localized by       the <code>Locale</code> header and ordered by name.</br></br>      <strong>Where they go.</strong> <code>vasp_entity_country</code>, <code>sender.residence_country</code>       (deposit), <code>recipient.residence_country</code> (withdrawal) and <code>fx_residence_country</code>.       <code>BR</code> stands for Brazil. See the <a href=\"#tag/Travel-Rule\">Travel Rule</a> section for the       declaration flow.</br></br>      <strong>Cache:</strong> 10 minutes.</br>      <strong>Rate Limit:</strong> 2 requests per 2 seconds.","operationId":"list-travel-rule-countries","parameters":[{"name":"Locale","in":"header","description":"Language used to localize the country <code>name</code> field.       Accepted values (case-sensitive): <code>EN</code>, <code>PT-BR</code>. Defaults to <code>EN</code>       when the header is omitted. Any other value causes the request to fail with       <strong>400 Bad Request</strong>.","required":false,"schema":{"type":"string","enum":["EN","PT-BR"],"default":"EN"}}],"responses":{"200":{"description":"The list of countries was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Countries"}}}}},"summary":"List Travel Rule countries","tags":["Travel Rule"]}}},"info":{"version":"3.0","title":"Foxbit REST API","description":"We provide an OpenAPI specification for our REST API, which is a standard way to describe the API's endpoints, request and response formats, authentication methods, and other details. This specification can be downloaded at: <a href=\"public-docs-openapi.json\" target=\"_blank\" download=\"foxbit-rest-v3-openapi.json\">OpenAPI Specification</a>.<br> We also provide a Postman collection and environment to help you get started with our API. The instructions are available in the <a href=\"#tag/Tutorials/Integrating-with-Postman\">Integrating with Postman</a> section.<br> Follow our <a href=\"https://status.foxbit.com/\" target=\"_blank\">Status Page</a> for real-time updates on system performance and maintenance schedules. You can also subscribe to receive notifications about any incidents or scheduled maintenance that may affect the API's availability.<br> For support with the Foxbit API, please visit our <a href=\"https://faq.foxbit.com.br/hc/pt-br/requests/new\" target=\"_blank\">Help Center</a>.\n","x-logo":{"url":"https://docs.foxbit.com.br/rest/v3/logo-with-text.svg","href":"/"}},"tags":[{"name":"Market Data","description":"Public endpoints for accessing real-time and historical market information. Use these endpoints to retrieve\navailable trading pairs, price quotations, order book snapshots, candlestick charts, ticker summaries and\nrecent public trades. No authentication is required.\n"},{"name":"Banks","description":"Public endpoint for retrieving the list of supported Brazilian banks. The bank code returned can be used to\nvalidate bank account information when submitting fiat withdrawals. No authentication is required.\n"},{"name":"System","description":"Public endpoint for retrieving the API server time. Use this to synchronize your local clock with the server,\nwhich is essential for generating valid request signatures for authenticated endpoints. No authentication is required.\n"},{"name":"Member Info","description":"Authenticated endpoints for retrieving the current member's profile information, including account details,\nregistration level, status and personalized trading fee rates across all markets.\n"},{"name":"Trading","description":"Authenticated endpoints for managing orders and viewing trade history. Includes operations for creating orders\n(Limit, Market, Instant, StopLimit, StopMarket, TrailingStopLimit, TrailingStopMarket, Oco), batch order creation,\ncancel-and-replace, order cancellation and retrieving executed trades.\n"},{"name":"Account","description":"Authenticated endpoints for retrieving currency balances and transaction history. View total, available and locked\nbalances per currency, and query detailed account movements including trades, deposits, withdrawals and internal transfers.\n"},{"name":"Deposit","description":"Authenticated endpoints for managing deposits. List deposit transactions, retrieve details of a specific deposit\nby serial number, and get or generate cryptocurrency deposit addresses for supported networks.\n"},{"name":"Withdrawal","description":"Authenticated endpoints for managing withdrawals. List withdrawal transactions, retrieve details of a specific withdrawal\nby serial number, and submit new withdrawal requests for both cryptocurrency (to external wallets) and fiat currency\n(to bank accounts). Creating withdrawals requires the **withdraw** API key permission.\n"},{"name":"Travel Rule","description":"The Travel Rule asks who is on the other side of a crypto deposit or withdrawal. When it applies,\nthe operation is held in `AWAITING_TRAVEL_RULE` until you declare it: a deposit is not credited and a withdrawal is\nnot sent until then.\n\n**Start with the guide:** [How to declare the Travel Rule](#tag/Tutorials/How-to-declare-the-Travel-Rule),\nthe same steps for a deposit and for a withdrawal.\n\nThe declaration, its purposes and its documents live under the operation itself, in [Deposit](#tag/Deposit) and\n[Withdrawal](#tag/Withdrawal). This section holds the catalog they read from:\n[`GET /travel_rule/countries`](#tag/Travel-Rule/operation/list-travel-rule-countries), the countries a\ndeclaration accepts.\n"},{"name":"Transactional Limits","description":"Authenticated endpoint for retrieving the member's deposit and withdrawal limits per currency. Each entry shows the\ntotal allowed limit and the remaining available amount. Limits may vary based on KYC verification level.\n"},{"name":"Prime Desk","description":"Authenticated endpoints for the Prime Desk trading service, designed for executing large cryptocurrency trades\nwith dedicated pricing and deeper liquidity. The workflow involves requesting a time-limited quote and then\nexecuting it.\n"}],"servers":[{"url":"https://api.foxbit.com.br","description":"Foxbit REST V3 API","variables":{"API_KEY":{"default":"","description":"Your api key goes here"},"API_SECRET":{"default":"","description":"Your api secret goes here"},"CURRENT_SIGNATURE":{"default":"","description":"Auto generated field, it will be generated using pre request script"},"CURRENT_TIMESTAMP":{"default":"","description":"Auto generated field, it will be generated using pre request script"}}}],"components":{"schemas":{"UnauthorizedError":{"type":"object","properties":{"message":{"type":"string","description":"The message describing exception that occurred.","example":"Invalid access key."},"code":{"type":"number","description":"A numeric code that identifies the specific type of error.\n  For more information, please refer to the <a href=\"#tag/API-Codes/Errors\">Error Codes</a> section.","example":2003},"details":{"description":"Additional and specific information about the error occurrence.","example":["Access key missing, invalid or not found."],"type":"array","items":{"type":"string"}}},"required":["message","code","details"]},"UnauthorizedErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UnauthorizedError"}},"required":["error"]},"Member":{"type":"object","properties":{"sn":{"type":"string","description":"Alphanumeric unique identifier","example":"FRR3DTLHGJ7DPB"},"email":{"type":"string","description":"Email address","example":"nakamoto.satoshi@example.com"},"level":{"type":"number","description":"Registration level in the exchange","example":10},"created_at":{"type":"string","description":"Creation date in ISO-8601 UTC","example":"2021-11-25T13:23:27.961Z"},"disabled":{"type":"boolean","description":"Whether the member is disabled","example":false}}},"TradingFee":{"type":"object","properties":{"market_symbol":{"type":"string","example":"btcbrl","description":"The market symbol"},"maker":{"type":"string","example":"0.0025","description":"The fee for the maker orders"},"taker":{"type":"string","example":"0.005","description":"The fee for the taker orders"}},"required":["market_symbol","maker","taker"]},"TradingFeesResponse":{"type":"object","properties":{"data":{"description":"The trading fees for all markets","type":"array","items":{"$ref":"#/components/schemas/TradingFee"}}},"required":["data"]},"CurrencyCategory":{"type":"object","properties":{"code":{"type":"string","description":"Currency category code","example":"cripto"},"name":{"type":"string","description":"Currency category display name","example":"Cripto"}}},"CurrencyDepositInfo":{"type":"object","properties":{"min_to_confirm":{"type":"string","description":"Minimum number of confirmations","example":"1","nullable":true},"min_amount":{"type":"string","nullable":true,"description":"Minimum deposit amount","example":"0.0001"},"enabled":{"type":"boolean","description":"Whether a new deposit address can be generated for this currency","example":true}}},"CurrencyWithdrawInfo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the currency is available for withdrawal","example":true},"min_amount":{"type":"string","description":"Minimum withdrawal amount","example":"0.0001","nullable":true},"fee":{"type":"string","description":"Withdrawal fee","example":"0.0001","nullable":true}}},"NetworkDepositInfo":{"type":"object","properties":{"status":{"type":"string","description":"Indicates if the network is active for deposits","example":"ENABLED","enum":["ENABLED","DISABLED"]}}},"NetworkWithdrawInfo":{"type":"object","properties":{"status":{"type":"string","description":"Indicates if the network is active for withdrawals","example":"ENABLED","enum":["ENABLED","DISABLED"]},"fee":{"type":"string","description":"Estimated fee for performing a withdrawal. The fee is based on current network conditions\n    and may be updated frequently. We recommend checking the final fee at the time of the transaction","example":"0.0001","nullable":true}}},"Network":{"type":"object","properties":{"name":{"type":"string","description":"The network name","example":"Bitcoin"},"code":{"type":"string","description":"The network code. It will be used to create deposits and withdrawals","example":"bitcoin"},"deposit_info":{"description":"Information about deposits in the network","allOf":[{"$ref":"#/components/schemas/NetworkDepositInfo"}]},"withdraw_info":{"description":"Information about withdrawals in the network","allOf":[{"$ref":"#/components/schemas/NetworkWithdrawInfo"}]},"has_destination_tag":{"type":"boolean","description":"Indicates if the network has a destination tag","example":false}}},"Currency":{"type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol","example":"btc"},"name":{"type":"string","description":"Currency name","example":"Bitcoin"},"type":{"type":"string","description":"Kind of currency","example":"CRYPTO","enum":["CRYPTO","FIAT"]},"precision":{"type":"number","description":"Number of decimals used by the currency","example":8},"category":{"description":"Extra information about the currency category","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/CurrencyCategory"}]},"deposit_info":{"description":"Extra information about deposits","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/CurrencyDepositInfo"}]},"withdraw_info":{"description":"Extra information about withdrawals","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/CurrencyWithdrawInfo"}]},"networks":{"description":"Extra information about currency networks","type":"array","items":{"$ref":"#/components/schemas/Network"}},"default_network_code":{"type":"string","description":"Default network code. It will be used as default for deposits and withdrawals","example":"bitcoin"}}},"Currencies":{"type":"object","properties":{"data":{"description":"The list of currencies","type":"array","items":{"$ref":"#/components/schemas/Currency"}}}},"Fees":{"type":"object","properties":{"maker":{"type":"string","description":"Fee charged when a maker order is executed.\n    <br/>The value is a decimal multiplier (e.g., 0.001 = 0.1% fee).\n    <br/>MAKER: order that goes into the order book, adding liquidity to the market e.g. a post-only limit order","example":"0.001"},"taker":{"type":"string","description":"Fee charged when a taker order is executed\n    <br/>The value is a decimal multiplier (e.g., 0.001 = 0.1% fee).\n    <br/>TAKER: order that removes liquidity from the market e.g. a market order","example":"0.001"}}},"MarketCurrency":{"type":"object","properties":{"name":{"type":"string","description":"Currency name","example":"Bitcoin"},"precision":{"type":"number","description":"Number of decimals used by the currency","example":8},"symbol":{"type":"string","description":"Currency symbol","example":"btc"},"type":{"type":"string","description":"Kind of currency","example":"CRYPTO","enum":["CRYPTO","FIAT"]}}},"Market":{"type":"object","properties":{"symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"quantity_min":{"type":"string","description":"Minimum quantity allowed for orders on this market","example":"0.00000236"},"quantity_increment":{"type":"string","description":"Increment value for the quantity of the market","example":"0.00000001"},"quantity_precision":{"type":"number","description":"Number of decimal places allowed for the order quantity","example":8},"price_min":{"type":"string","description":"Min price of the market. Use `price_precision` for precision information","example":"0.0001","deprecated":true},"price_increment":{"type":"string","description":"Increment value for the price of the market","example":"0.0001"},"price_precision":{"type":"number","description":"Number of decimal places allowed for the order price","example":4},"default_fees":{"description":"The default market fees. These are baseline values — actual fees may vary per user. For detailed user-specific fees,\n                  see our [trading fees endpoint](#tag/Member-Info/operation/trading-fees)","allOf":[{"$ref":"#/components/schemas/Fees"}]},"base":{"example":{"name":"Bitcoin","symbol":"btc","precision":8,"type":"CRYPTO"},"allOf":[{"$ref":"#/components/schemas/MarketCurrency"}]},"quote":{"example":{"name":"Real","symbol":"brl","precision":2,"type":"FIAT"},"allOf":[{"$ref":"#/components/schemas/MarketCurrency"}]},"order_type":{"type":"array","description":"Order types allowed on this market\n    <table>\n      <thead>\n        <tr>\n          <th>Type</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>LIMIT</td>\n          <td>Executes at the specified price or better; rests on the order book until filled or canceled</td>\n        </tr>\n        <tr>\n          <td>MARKET</td>\n          <td>Executes immediately at the best available price, for a quantity expressed in the base currency</td>\n        </tr>\n        <tr>\n          <td>INSTANT</td>\n          <td>Executes immediately at the best available price, for an amount expressed in the quote currency</td>\n        </tr>\n        <tr>\n          <td>STOP_LIMIT</td>\n          <td>Places a limit order once the market reaches the stop price</td>\n        </tr>\n        <tr>\n          <td>STOP_MARKET</td>\n          <td>Places a market order once the market reaches the stop price</td>\n        </tr>\n        <tr>\n          <td>TRAILING_STOP_MARKET</td>\n          <td>A stop market order whose stop price trails the market</td>\n        </tr>\n        <tr>\n          <td>TRAILING_STOP_LIMIT</td>\n          <td>A stop limit order whose stop price trails the market</td>\n        </tr>\n        <tr>\n          <td>OCO</td>\n          <td>A take-profit limit and a stop-loss stop limit under one order; the first to activate cancels the other</td>\n        </tr>\n      </tbody>\n    </table>","example":["LIMIT","MARKET","INSTANT","STOP_LIMIT","STOP_MARKET","TRAILING_STOP_LIMIT","TRAILING_STOP_MARKET","OCO"],"items":{"type":"string","enum":["LIMIT","MARKET","INSTANT","STOP_LIMIT","STOP_MARKET","TRAILING_STOP_MARKET","TRAILING_STOP_LIMIT","OCO"]}}}},"Markets":{"type":"object","properties":{"data":{"description":"The list of markets","type":"array","items":{"$ref":"#/components/schemas/Market"}}}},"Quote":{"type":"object","properties":{"side":{"type":"string","description":"The side of the quotation","example":"buy","enum":["buy","sell"]},"market_symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"base_amount":{"type":"string","description":"Amount expressed in the base currency","example":"0.00256410"},"quote_amount":{"type":"string","description":"Amount expressed in the quote currency","example":"1000.0"},"price":{"type":"string","description":"Average quote price","example":"390000.00"}}},"OrderbookDepth":{"type":"object","properties":{"sequence_id":{"type":"number","description":"Incremental number that represents the current state of the order book","example":1234567890},"timestamp":{"type":"number","description":"Timestamp in milliseconds associated with the sequence_id","example":1713187921336},"bids":{"type":"array","description":"Array of bids where each item is an array composed of price and quantity","example":[["349500.00000000","0.50000000"],["349000.00000000","1.20000000"]],"items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}},"asks":{"type":"array","description":"Array of asks where each item is an array composed of price and quantity","example":[["350000.00000000","0.30000000"],["350500.00000000","0.80000000"]],"items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}}},"required":["sequence_id","timestamp","bids","asks"]},"LastTrade":{"type":"object","properties":{"price":{"type":"string","description":"The latest price at which the asset was traded","example":"358504.69340000"},"volume":{"type":"string","description":"The amount of the asset traded in the last trade","example":"0.00027893"},"date":{"type":"string","description":"The date of the last trade in ISO 8601 format","example":"2024-01-01T00:00:00.000Z"}},"required":["price","volume"]},"Rolling24Hr":{"type":"object","properties":{"price_change":{"type":"string","description":"The absolute change in price over the past 24 hours","example":"3211.87290000"},"price_change_percent":{"type":"string","description":"The percentage change in price over the past 24 hours","example":"0.90400726"},"volume":{"type":"string","description":"The total value in base currency traded over the past 24 hours","example":"20.03206866"},"quote_volume":{"type":"string","description":"The total value in quote currency traded over the past 24 hours","example":"7165463.92150000"},"trades_count":{"type":"number","description":"The total number of trades executed for the asset over the past 24 hours","example":4376},"open":{"type":"string","description":"The opening price of the asset for the past 24-hour period","example":"355292.82050000"},"high":{"type":"string","description":"The highest price reached by the asset over the past 24 hours","example":"362999.99990000"},"low":{"type":"string","description":"The lowest price reached by the asset over the past 24 hours","example":"355002.88880000"}},"required":["price_change","price_change_percent","volume","quote_volume","trades_count","open","high","low"]},"BestSideWithVolume":{"type":"object","properties":{"price":{"type":"string","description":"The current best price for buying (ask) or selling (bid) the asset","example":"358504.69340000"},"volume":{"type":"string","description":"The amount of the asset available for buying or selling at the best price","example":"0.00027893"}},"required":["price","volume"]},"BestWithVolume":{"type":"object","properties":{"ask":{"description":"Information about the best ask price and volume","example":{"price":"358600.00000000","volume":"0.00027893"},"allOf":[{"$ref":"#/components/schemas/BestSideWithVolume"}]},"bid":{"description":"Information about the best bid price and volume","example":{"price":"358400.00000000","volume":"0.01500000"},"allOf":[{"$ref":"#/components/schemas/BestSideWithVolume"}]}},"required":["ask","bid"]},"TickerWithBest":{"type":"object","properties":{"market_symbol":{"type":"string","description":"The symbol of the asset being traded","example":"btcbrl"},"last_trade":{"description":"Information about the most recent trade for this asset","allOf":[{"$ref":"#/components/schemas/LastTrade"}]},"rolling_24h":{"description":"Data on the asset's price and volume changes over the past 24 hours","allOf":[{"$ref":"#/components/schemas/Rolling24Hr"}]},"best":{"description":"Contains information about the current best ask and bid prices and volumes","allOf":[{"$ref":"#/components/schemas/BestWithVolume"}]}},"required":["market_symbol","last_trade","rolling_24h","best"]},"GetTickerWithBestResponse":{"type":"object","properties":{"data":{"description":"An array of objects containing detailed information about each ticker, including last trade, 24-hour rolling data, and best ask/bid prices","type":"array","items":{"$ref":"#/components/schemas/TickerWithBest"}}},"required":["data"]},"BestSide":{"type":"object","properties":{"price":{"type":"string","description":"The current best price for buying (ask) or selling (bid) the asset","example":"358504.69340000"}},"required":["price"]},"Best":{"type":"object","properties":{"ask":{"description":"Information about the best ask price","example":{"price":"358600.00000000"},"allOf":[{"$ref":"#/components/schemas/BestSide"}]},"bid":{"description":"Information about the best bid price","example":{"price":"358400.00000000"},"allOf":[{"$ref":"#/components/schemas/BestSide"}]}},"required":["ask","bid"]},"Ticker":{"type":"object","properties":{"market_symbol":{"type":"string","description":"The symbol of the asset being traded","example":"btcbrl"},"last_trade":{"description":"Information about the most recent trade for this asset","allOf":[{"$ref":"#/components/schemas/LastTrade"}]},"rolling_24h":{"description":"Data on the asset's price and volume changes over the past 24 hours","allOf":[{"$ref":"#/components/schemas/Rolling24Hr"}]},"best":{"description":"Contains information about the current best ask and bid prices","allOf":[{"$ref":"#/components/schemas/Best"}]}},"required":["market_symbol","last_trade","rolling_24h"]},"GetTickerResponse":{"type":"object","properties":{"data":{"description":"An array of objects containing basic ticker information, including market symbol, last trade, and 24-hour rolling data","type":"array","items":{"$ref":"#/components/schemas/Ticker"}}},"required":["data"]},"PublicTrade":{"type":"object","properties":{"id":{"type":"number","description":"Trade ID","example":12345678},"price":{"type":"string","description":"Trade price","example":"329248.74700000"},"volume":{"type":"string","description":"Trade volume","example":"0.00100000"},"taker_side":{"type":"string","description":"The side of the taker order (the order that removed liquidity from the book)","example":"BUY","enum":["BUY","SELL"]},"created_at":{"type":"string","description":"The creation date of this trade in ISO-8601 UTC","example":"2024-01-01T00:00:00.000Z"}}},"PublicTrades":{"type":"object","properties":{"data":{"description":"Public trades data","type":"array","items":{"$ref":"#/components/schemas/PublicTrade"}}}},"Sparkline":{"type":"object","properties":{"market_symbol":{"type":"string","description":"Market symbol identifier","example":"btcbrl"},"points":{"type":"array","description":"Array of data points with timestamp and price values","example":[["1756472400000","589106.00000000"],["1756476000000","589150.00000000"],["1756479600000","589150.00000000"],["1756483200000","590148.00000000"],["1756486800000","589755.00000000"]],"items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}}},"required":["market_symbol","points"]},"Sparklines":{"type":"object","properties":{"data":{"description":"Array of sparkline data for different market symbols","type":"array","items":{"$ref":"#/components/schemas/Sparkline"}}},"required":["data"]},"Sparkline400Error":{"type":"object","properties":{"message":{"type":"string","description":"General error message indicating the type of request failure","example":"Bad request."},"code":{"type":"number","description":"HTTP status code indicating a client error (400 Bad Request)","example":400},"details":{"description":"Array of specific validation error messages explaining what went wrong with the request","example":["interval must be a valid enum value for the requested window. Allowed intervals: [1m]"],"type":"array","items":{"type":"string"}}},"required":["message","code","details"]},"Sparkline400":{"type":"object","properties":{"error":{"description":"Error response object containing detailed information about the bad request","allOf":[{"$ref":"#/components/schemas/Sparkline400Error"}]}},"required":["error"]},"OrderLimit":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"LIMIT","enum":["LIMIT"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"},"price":{"type":"string","description":"The price intended to buy or sell, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places","example":"250000.0"},"post_only":{"type":"boolean","description":"When true your order will not be executed immediately in the market. <br />\n      It will exist as a maker order on the order book. Maker orders add liquidity to the market. <br />\n      Only compatible with time_in_force <b>GTC</b>; if the order would match immediately, it is canceled with cancellation reason <b>202</b>","example":true},"time_in_force":{"type":"string","description":"<b>TimeInForce (TIF)</b> defines how long an order remains active before it is executed or canceled.\n    Foxbit currently supports: <br /><b>Good 'til Cancelled (GTC):</b> the order stays active until\n    it is fully filled or canceled manually by the trader;<br /><b>Fill or Kill (FOK):</b> the order must be <b>fully filled immediately</b>.\n    If 100% of the quantity cannot be filled at once, the <b>entire order is canceled</b> (no partial fills);\n    <br /><b>Immediate or Cancel (IOC):</b> any part of the order that can be filled <b>immediately</b> is executed,\n    and <b>any remaining quantity is canceled</b> (allows partial fills, unlike FOK).\n    <br />Only applicable to LIMIT and STOP_LIMIT orders. Default: <b>GTC</b>","example":"GTC","enum":["GTC","FOK","IOC"]}},"required":["side","type","market_symbol","quantity","price"]},"OrderMarket":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"MARKET","enum":["MARKET"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"}},"required":["side","type","market_symbol","quantity"]},"OrderInstant":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"INSTANT","enum":["INSTANT"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"amount":{"type":"string","description":"The amount intended to buy or sell, expressed in the quote currency\n      and string formatted. Use this field with orders of type INSTANT. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"1000.0"}},"required":["side","type","market_symbol","amount"]},"OrderStopLimit":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"STOP_LIMIT","enum":["STOP_LIMIT"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"},"price":{"type":"string","description":"The price intended to buy or sell, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places.\n      <br />On a <b>SELL</b> it must be at or below <b>stop_price</b>; on a <b>BUY</b>, at or above it","example":"250000.0"},"post_only":{"type":"boolean","description":"When true your order will not be executed immediately in the market. <br />\n      It will exist as a maker order on the order book. Maker orders add liquidity to the market. <br />\n      Only compatible with time_in_force <b>GTC</b>; if the order would match immediately, it is canceled with cancellation reason <b>202</b>","example":true},"time_in_force":{"type":"string","description":"<b>TimeInForce (TIF)</b> defines how long an order remains active before it is executed or canceled.\n    Foxbit currently supports: <br /><b>Good 'til Cancelled (GTC):</b> the order stays active until\n    it is fully filled or canceled manually by the trader;<br /><b>Fill or Kill (FOK):</b> the order must be <b>fully filled immediately</b>.\n    If 100% of the quantity cannot be filled at once, the <b>entire order is canceled</b> (no partial fills);\n    <br /><b>Immediate or Cancel (IOC):</b> any part of the order that can be filled <b>immediately</b> is executed,\n    and <b>any remaining quantity is canceled</b> (allows partial fills, unlike FOK).\n    <br />Only applicable to LIMIT and STOP_LIMIT orders. Default: <b>GTC</b>","example":"GTC","enum":["GTC","FOK","IOC"]},"stop_price":{"type":"string","description":"Price to trigger a stop order, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places","example":"240000.0"}},"required":["side","type","market_symbol","quantity","price","stop_price"]},"OrderStop":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"STOP_MARKET","enum":["STOP_MARKET"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"stop_price":{"type":"string","description":"Price to trigger a stop order, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places","example":"240000.0"},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"}},"required":["side","type","market_symbol","stop_price","quantity"]},"OrderTrailingStopLimit":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"TRAILING_STOP_LIMIT","enum":["TRAILING_STOP_LIMIT"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"stop_price":{"type":"string","description":"Price to trigger a stop order, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places.\n      <br /><br />It is where the trail <b>starts</b>, not where the order fires: from the\n      first trade on it follows the market, and the value you read on the order is the one in\n      force. <b>origin_stop_price</b> keeps the one sent here.\n      <br /><br />It has to sit inside the market's price band, a range around the last traded\n      price set per market, so a trailing stop cannot be armed at a distance the book has no\n      relation to. On every market that offers trailing stop orders the factor is <b>5</b>: the\n      band runs from the last traded price <b>divided by 5</b> to the last traded price\n      <b>multiplied by 5</b>. A value outside it is answered with <b>price_out_of_range</b>\n      (code <b>5005</b>).\n      <br /><br />An account may keep <b>5</b> trailing stop orders open at a time, counting\n      both types and every market together. The sixth is rejected until one of them triggers or\n      is cancelled","example":"240000.0"},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"},"trail_type":{"type":"string","description":"How the trail distance is read. <br /><b>AMOUNT:</b> an absolute value in the\n      quote currency; <br /><b>PERCENT:</b> a whole percentage of the price the stop trails\n      (<b>2</b> means 2%). <br />Required for trailing stop orders","example":"AMOUNT","enum":["AMOUNT","PERCENT"]},"trail_value":{"type":"string","description":"The distance the stop price keeps from the market as it moves in the order's\n      favour, string formatted with a maximum of 16 decimal places. Read according to\n      <b>trail_type</b>.\n      <br /><br />With <b>AMOUNT</b> it is a price distance, so it has to be a multiple of the\n      market's <b>price_increment</b> from <code>GET /markets</code> &mdash; the smallest\n      difference between two valid prices. A market whose increment is <b>1</b> takes <b>1</b>,\n      <b>2</b>, <b>500</b>; one whose increment is <b>0.01</b> takes <b>0.01</b>, <b>0.5</b>,\n      <b>2.55</b>. A distance finer than the increment is rejected rather than rounded: the\n      engine truncates the stop to the market's precision, so a value below it would move the\n      stop by a different amount than the one you sent.\n      <br /><br />It is also capped against the book, so the stop does not start at a distance\n      unrelated to the market. The ceiling is a multiple of the last traded price, set per\n      market, and is <b>5 times</b> the last traded price on every market that offers trailing\n      stop orders &mdash; the same factor that bounds <b>stop_price</b>. An order above it is\n      answered with <b>price_out_of_range</b> (code <b>5005</b>).\n      <br /><br />With <b>PERCENT</b> it is a whole number above <b>0</b> and below <b>100</b>:\n      <b>1</b>, <b>2</b>, <b>50</b>. A fraction such as <b>2.5</b> is rejected.\n      <br /><br /><b>Example.</b> A sell on a market quoted in whole units, with\n      <b>stop_price</b> <code>400000</code> and <b>trail_value</b> <code>5000</code>, keeps the\n      stop 5,000 below the highest price traded. The market rises to <code>420000</code> and the\n      stop follows to <code>415000</code>; the market dips and the stop stays where it is. The\n      order triggers once a trade prints at <code>415000</code> or below.\n      <br /><br />Required for trailing stop orders","example":"500.0"},"limit_offset":{"type":"string","description":"The offset the limit price keeps from the stop price when the order triggers,\n      expressed in the quote currency and string formatted with a maximum of 16 decimal places.\n      <br />The order carries no <b>price</b> of its own: it is derived at trigger time from the\n      stop price the trail arrived at (sell orders subtract the offset, buy orders add it).\n      <br /><br />Like <b>trail_value</b> with <b>AMOUNT</b>, it is a price distance: it has to be\n      a multiple of the market's <b>price_increment</b> from <code>GET /markets</code>. An offset\n      finer than the increment would place the limit price between two prices the market cannot\n      quote.\n      <br /><br />Required for <b>TRAILING_STOP_LIMIT</b> and rejected for\n      <b>TRAILING_STOP_MARKET</b>","example":"50.0"}},"required":["side","type","market_symbol","stop_price","quantity","trail_type","trail_value","limit_offset"]},"OrderTrailingStopMarket":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"TRAILING_STOP_MARKET","enum":["TRAILING_STOP_MARKET"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"stop_price":{"type":"string","description":"Price to trigger a stop order, expressed in the quote currency <br/>\n      and string formatted. It needs to be a decimal with a maximum of 16 decimal places.\n      <br /><br />It is where the trail <b>starts</b>, not where the order fires: from the\n      first trade on it follows the market, and the value you read on the order is the one in\n      force. <b>origin_stop_price</b> keeps the one sent here.\n      <br /><br />It has to sit inside the market's price band, a range around the last traded\n      price set per market, so a trailing stop cannot be armed at a distance the book has no\n      relation to. On every market that offers trailing stop orders the factor is <b>5</b>: the\n      band runs from the last traded price <b>divided by 5</b> to the last traded price\n      <b>multiplied by 5</b>. A value outside it is answered with <b>price_out_of_range</b>\n      (code <b>5005</b>).\n      <br /><br />An account may keep <b>5</b> trailing stop orders open at a time, counting\n      both types and every market together. The sixth is rejected until one of them triggers or\n      is cancelled","example":"240000.0"},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"},"trail_type":{"type":"string","description":"How the trail distance is read. <br /><b>AMOUNT:</b> an absolute value in the\n      quote currency; <br /><b>PERCENT:</b> a whole percentage of the price the stop trails\n      (<b>2</b> means 2%). <br />Required for trailing stop orders","example":"AMOUNT","enum":["AMOUNT","PERCENT"]},"trail_value":{"type":"string","description":"The distance the stop price keeps from the market as it moves in the order's\n      favour, string formatted with a maximum of 16 decimal places. Read according to\n      <b>trail_type</b>.\n      <br /><br />With <b>AMOUNT</b> it is a price distance, so it has to be a multiple of the\n      market's <b>price_increment</b> from <code>GET /markets</code> &mdash; the smallest\n      difference between two valid prices. A market whose increment is <b>1</b> takes <b>1</b>,\n      <b>2</b>, <b>500</b>; one whose increment is <b>0.01</b> takes <b>0.01</b>, <b>0.5</b>,\n      <b>2.55</b>. A distance finer than the increment is rejected rather than rounded: the\n      engine truncates the stop to the market's precision, so a value below it would move the\n      stop by a different amount than the one you sent.\n      <br /><br />It is also capped against the book, so the stop does not start at a distance\n      unrelated to the market. The ceiling is a multiple of the last traded price, set per\n      market, and is <b>5 times</b> the last traded price on every market that offers trailing\n      stop orders &mdash; the same factor that bounds <b>stop_price</b>. An order above it is\n      answered with <b>price_out_of_range</b> (code <b>5005</b>).\n      <br /><br />With <b>PERCENT</b> it is a whole number above <b>0</b> and below <b>100</b>:\n      <b>1</b>, <b>2</b>, <b>50</b>. A fraction such as <b>2.5</b> is rejected.\n      <br /><br /><b>Example.</b> A sell on a market quoted in whole units, with\n      <b>stop_price</b> <code>400000</code> and <b>trail_value</b> <code>5000</code>, keeps the\n      stop 5,000 below the highest price traded. The market rises to <code>420000</code> and the\n      stop follows to <code>415000</code>; the market dips and the stop stays where it is. The\n      order triggers once a trade prints at <code>415000</code> or below.\n      <br /><br />Required for trailing stop orders","example":"500.0"}},"required":["side","type","market_symbol","stop_price","quantity","trail_type","trail_value"]},"OrderOco":{"type":"object","properties":{"side":{"type":"string","description":"The side of the order book you will place the order","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The type of the order to be created","example":"OCO","enum":["OCO"]},"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501"},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","maxLength":100},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n    to prevent users from inadvertently trading against themselves.\n    You can currently use: <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity;\n    <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity;\n    <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and\n    the potential maker order's remaining quantities;\n    <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity.\n    <br />Default: <b>EXPIRE_TAKER</b>","example":"EXPIRE_TAKER","enum":["EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"]},"slippage_tolerance":{"type":"string","description":"The slippage tolerance feature protects users from\n    unexpected price changes during trades, ensuring transactions\n    execute within acceptable limits and enhancing trading accuracy. <br />\n    Each fill is limited to the top-of-book price plus (for buys) or minus (for sells) the tolerance;\n    any remaining quantity that would execute beyond this band is canceled with cancellation reason <b>205</b>.\n    The effective tolerance may be capped by an exchange-side protection limit. <br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"sub_account_type":{"type":"string","description":"The sub-account type related to orders","enum":["PREDICTION"]},"stop_price":{"type":"string","description":"The stop-loss trigger price, expressed in the quote currency and string\n      formatted with a maximum of 16 decimal places. <br />On a <b>SELL</b> it must be below\n      <b>price</b>; on a <b>BUY</b>, above it","example":"360000.0"},"quantity":{"type":"string","description":"The quantity of the base currency you want to buy or sell,\n      expressed in string format. <br/>\n      It needs to be a decimal with a maximum of 16 decimal places","example":"0.42"},"price":{"type":"string","description":"The take-profit limit price, expressed in the quote currency and string\n      formatted with a maximum of 16 decimal places. <br />On a <b>SELL</b> it must be above\n      <b>stop_price</b>; on a <b>BUY</b>, below it","example":"330000.0"},"stop_limit_price":{"type":"string","description":"The limit price of the stop-loss once <b>stop_price</b> triggers, expressed in\n      the quote currency and string formatted with a maximum of 16 decimal places. <br />On a\n      <b>SELL</b> it must be at or below <b>stop_price</b>; on a <b>BUY</b>, at or above it.\n      <br />Required for <b>OCO</b> and rejected on every other type","example":"361000.0"}},"required":["side","type","market_symbol","stop_price","quantity","price","stop_limit_price"]},"OrderCreated":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"sn":{"type":"string","description":"Alphanumeric unique identifier of the order","example":"OKMAKSDHRVVREK","deprecated":true},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501","nullable":true}}},"OrderCreateBatchModel":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateOrderRequest"},"description":"Order create batch data","minItems":1,"maxItems":5}},"required":["data"]},"ErrorDetails":{"type":"object","properties":{"message":{"type":"string","description":"Error message","example":"Cannot submit order."},"code":{"type":"number","description":"Error code","example":4008},"details":{"description":"Error details","example":["The order cannot be created."],"type":"array","items":{"type":"string"}}},"required":["message","code","details"]},"OrderBatchResult":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501","nullable":true},"error":{"description":"Why this order was not created. Absent when it was","allOf":[{"$ref":"#/components/schemas/ErrorDetails"}]}}},"OrderBatchResponse":{"type":"object","properties":{"data":{"description":"Order batch create response","example":[{"client_order_id":"102938475610","error":{"code":4008,"details":["The order cannot be created."],"message":"Cannot submit order."}},{"id":"2148517470","client_order_id":"102938475611"},{"id":"2148517476","client_order_id":null}],"type":"array","items":{"$ref":"#/components/schemas/OrderBatchResult"}}},"required":["data"]},"ErrorData":{"type":"object","properties":{"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501","nullable":true},"error":{"description":"Error data","allOf":[{"$ref":"#/components/schemas/ErrorDetails"}]}},"required":["error"]},"OrderBatchResponseError":{"type":"object","properties":{"data":{"description":"Error details","type":"array","items":{"$ref":"#/components/schemas/ErrorData"}}},"required":["data"]},"OrderCancel":{"type":"object","properties":{"type":{"type":"string","description":"Type of cancellation request","example":"ID","enum":["ID","CLIENT_ORDER_ID"]},"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string. Required when `type` is `ID`.","example":"123456789"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order. Required when `type` is `CLIENT_ORDER_ID`.","example":"451637946501"}},"required":["type"]},"OrderCancelReplace":{"type":"object","properties":{"mode":{"type":"string","description":"Mode of the order cancel/replace.\n- `ALLOW_FAILURE`: In this mode, the cancellation and creation of orders are executed independently. This mode ensures that both operations are attempted without one being dependent on the success of the other.","enum":["ALLOW_FAILURE"],"example":"ALLOW_FAILURE"},"cancel":{"description":"Order cancel parameters","allOf":[{"$ref":"#/components/schemas/OrderCancel"}]},"create":{"description":"Order create parameters","allOf":[{"$ref":"#/components/schemas/CreateOrderRequest"}]}},"required":["mode","cancel","create"]},"OrderCancelReplaceCancelResult":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"123456789"},"error":{"description":"Why the cancel failed. Absent when it succeeded","allOf":[{"$ref":"#/components/schemas/ErrorDetails"}]}}},"OrderCancelReplaceCreateResult":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order, sent as a string of digits","example":"451637946501","nullable":true},"error":{"description":"Why the creation failed. Absent when it succeeded","allOf":[{"$ref":"#/components/schemas/ErrorDetails"}]}}},"OrderCanceledReplaced":{"type":"object","properties":{"cancel":{"description":"Order cancel response","allOf":[{"$ref":"#/components/schemas/OrderCancelReplaceCancelResult"}]},"create":{"description":"Order create response","allOf":[{"$ref":"#/components/schemas/OrderCancelReplaceCreateResult"}]}},"required":["cancel","create"]},"ErrorResponse":{"type":"object","properties":{"error":{"description":"Error details","allOf":[{"$ref":"#/components/schemas/ErrorDetails"}]}},"required":["error"]},"OrderCancelReplaceError":{"type":"object","properties":{"cancel":{"description":"Order cancel details response","example":{"error":{"code":404,"message":"Resource not found.","details":["Order not found."]}},"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]},"create":{"description":"Order create details response","example":{"error":{"code":4004,"message":"Invalid symbol.","details":["The market or asset symbol is invalid or not found."]}},"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}},"required":["cancel","create"]},"OrderLeg":{"type":"object","properties":{"role":{"type":"string","description":"Which face of the OCO order this leg is","example":"TAKE_PROFIT","enum":["TAKE_PROFIT","STOP_LOSS"]},"type":{"type":"string","description":"The order type the leg executes as","example":"LIMIT","enum":["LIMIT","STOP_LIMIT"]},"price":{"type":"string","description":"The limit price of the leg; on the stop-loss, the stop_limit_price the order was created with","example":"360000.0"},"stop_price":{"type":"string","description":"The price that triggers the stop-loss leg; null on the take-profit","example":"330000.0","nullable":true},"state":{"type":"string","description":"The state of the leg, derived from the order\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>ACTIVE</td>\n          <td>The leg can still execute</td>\n        </tr>\n        <tr>\n          <td>TRIGGERED</td>\n          <td>The stop price was hit and the stop-loss leg is on the book</td>\n        </tr>\n        <tr>\n          <td>FILLED</td>\n          <td>The order was fully executed by this leg</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>The leg can no longer execute: the other leg won or the order was canceled</td>\n        </tr>\n      </tbody>\n    </table>","example":"ACTIVE","enum":["ACTIVE","TRIGGERED","FILLED","CANCELED"]},"cancellation_reason":{"type":"string","description":"Why the leg was canceled: <b>SIBLING_FILLED</b> when the take-profit traded first,\n    <b>SIBLING_TRIGGERED</b> when the stop-loss triggered first, <b>ORDER_CANCELED</b> when the whole\n    order was canceled (the order's cancellation_reason carries the code). Null unless the leg is CANCELED","example":"SIBLING_FILLED","enum":["SIBLING_FILLED","SIBLING_TRIGGERED","ORDER_CANCELED"],"nullable":true}}},"OrderWithoutRemark":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"sn":{"type":"string","description":"Alphanumeric unique identifier (Deprecated by property \"id\")","example":"OKMAKSDHRVVREK","deprecated":true},"client_order_id":{"type":"string","description":"Client-provided numeric identifier of the order","example":"451637946501","nullable":true},"market_symbol":{"type":"string","description":"The market where the order was placed","example":"btcbrl"},"side":{"type":"string","description":"The order book side where the order was placed","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The order type","example":"LIMIT","enum":["LIMIT","MARKET","INSTANT","STOP_LIMIT","STOP_MARKET","TRAILING_STOP_MARKET","TRAILING_STOP_LIMIT","OCO"]},"state":{"type":"string","description":"The current order state\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>ACTIVE</td>\n          <td>The order is in the matching queue, waiting for a match</td>\n        </tr>\n        <tr>\n          <td>PARTIALLY_FILLED</td>\n          <td>Part of the order has been filled and the remaining quantity is in the matching queue</td>\n        </tr>\n        <tr>\n          <td>FILLED</td>\n          <td>The order has been fully filled and is no longer in the matching queue</td>\n        </tr>\n        <tr>\n          <td>PARTIALLY_CANCELED</td>\n          <td>The order was partially traded, but the remaining quantity was canceled</td>\n        </tr>\n        <tr>\n          <td>PENDING_CANCEL</td>\n          <td>The order was removed from the matching queue and is awaiting fund release to finalize the cancellation</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>The order was completely canceled and has no associated trades</td>\n        </tr>\n      </tbody>\n    </table>","example":"ACTIVE","enum":["ACTIVE","CANCELED","FILLED","PARTIALLY_CANCELED","PARTIALLY_FILLED","PENDING_CANCEL"]},"price":{"type":"string","description":"The limit price, when it is a limit order. On an OCO, the take-profit limit until the\n    stop-loss triggers, then the stop-loss limit","example":"290000.0","nullable":true},"stop_price":{"type":"string","description":"The price that triggers the order, on the order types that carry one; on an OCO, the stop-loss trigger.\n    A trailing stop moves it on its own while the market runs in the order's favour, so\n    what it holds is where the trigger stands now, not where the order was created","example":"240000.0","nullable":true},"price_avg":{"type":"string","description":"The average traded price of the order","example":"295333.3333"},"quantity":{"type":"string","description":"The quantity of this order still to be executed (0.0 once it is filled)","example":"0.42"},"quantity_executed":{"type":"string","description":"The current quantity executed of this order","example":"0.41"},"instant_amount":{"type":"string","description":"The amount intended to execute in this order (for INSTANT orders)","example":"290.0","nullable":true},"instant_amount_executed":{"type":"string","description":"The current amount executed of this order (for INSTANT orders)","example":"290.0","nullable":true},"created_at":{"type":"string","description":"The creation date of this order in ISO-8601 UTC","example":"2021-02-15T22:06:32.999Z"},"trades_count":{"type":"number","description":"The current number of trades executed with this order","example":2},"fee_paid":{"type":"string","description":"The fee paid for the order execution","example":"0.0"},"post_only":{"type":"boolean","description":"When true, the order only adds liquidity to the market and never matches\n      with orders already on the book","example":false},"time_in_force":{"type":"string","description":"<b>TimeInForce (TIF)</b> defines how long an order remains active before it is executed or canceled.\n    Foxbit currently supports: <br /><b>Good 'til Cancelled (GTC):</b> the order stays active until\n    it is fully filled or canceled manually by the trader;<br /><b>Fill or Kill (FOK):</b> the order must be <b>fully filled immediately</b>.\n    If 100% of the quantity cannot be filled at once, the <b>entire order is canceled</b> (no partial fills);\n    <br /><b>Immediate or Cancel (IOC):</b> any part of the order that can be filled <b>immediately</b> is executed,\n    and <b>any remaining quantity is canceled</b> (allows partial fills, unlike FOK).\n    <br />Only applicable to LIMIT and STOP_LIMIT orders. Default: <b>GTC</b>","example":"GTC","enum":["GTC","FOK","IOC"],"nullable":true},"cancellation_reason":{"type":"number","description":"Indicates the reason for canceling an order.\n      See the <a href=\"https://docs.foxbit.com.br/rest/v3/#tag/API-Codes\">API Codes</a> section for the list of possible cancellation reasons","example":100,"nullable":true},"cancellation_reason_order_id":{"type":"string","description":"ID of the counterparty order that triggered this order's cancellation, when applicable\n      (e.g., for Self Trade Prevention)","example":"12345","nullable":true},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n      to prevent users from inadvertently trading against themselves.\n      <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity.\n      <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity.\n      <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and maker orders.\n      <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity\n      <br /><b>NONE:</b> Self Trade Prevention is off. Only accounts enabled for it keep it, others get EXPIRE_TAKER","example":"EXPIRE_TAKER","enum":["NONE","EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"],"nullable":true},"slippage_tolerance":{"type":"string","nullable":true,"description":"The slippage tolerance feature protects users from \n    unexpected price changes during trades, \n    ensuring transactions execute within acceptable limits and enhancing trading accuracy.<br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"trail_type":{"type":"string","description":"How the trail distance is read: <b>AMOUNT</b> for an absolute value in\n    the quote currency, <b>PERCENT</b> for a percentage of the price the stop trails.\n    Only trailing stop orders carry it","example":"AMOUNT","enum":["AMOUNT","PERCENT"],"nullable":true},"trail_value":{"type":"string","description":"The trail distance the order was created with, read per trail_type","example":"500.0","nullable":true},"limit_offset":{"type":"string","description":"The offset the limit price keeps from the stop price at trigger time.\n    Only a TRAILING_STOP_LIMIT carries it","example":"50.0","nullable":true},"origin_stop_price":{"type":"string","description":"The stop price the trailing stop was created with, before any move.\n    The distance the trail has walked is stop_price minus this one","example":"240000.0","nullable":true},"stop_price_updated_at":{"type":"string","description":"When the matching engine last moved the stop price. Null while the\n    trail has not moved yet","example":"2026-10-07T13:45:12.000Z","nullable":true},"legs":{"description":"The take-profit and stop-loss legs of an OCO order, in that order.\n    Null for any other order type","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OrderLeg"}},"oco_winner_leg":{"type":"string","description":"The leg an OCO order committed to: STOP_LOSS once stop_price triggers,\n    TAKE_PROFIT after a first trade. Null while both legs are active and for any other order type","example":"STOP_LOSS","enum":["TAKE_PROFIT","STOP_LOSS"],"nullable":true}}},"Order":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"sn":{"type":"string","description":"Alphanumeric unique identifier (Deprecated by property \"id\")","example":"OKMAKSDHRVVREK","deprecated":true},"client_order_id":{"type":"string","description":"Client-provided numeric identifier of the order","example":"451637946501","nullable":true},"market_symbol":{"type":"string","description":"The market where the order was placed","example":"btcbrl"},"side":{"type":"string","description":"The order book side where the order was placed","example":"BUY","enum":["BUY","SELL"]},"type":{"type":"string","description":"The order type","example":"LIMIT","enum":["LIMIT","MARKET","INSTANT","STOP_LIMIT","STOP_MARKET","TRAILING_STOP_MARKET","TRAILING_STOP_LIMIT","OCO"]},"state":{"type":"string","description":"The current order state\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>ACTIVE</td>\n          <td>The order is in the matching queue, waiting for a match</td>\n        </tr>\n        <tr>\n          <td>PARTIALLY_FILLED</td>\n          <td>Part of the order has been filled and the remaining quantity is in the matching queue</td>\n        </tr>\n        <tr>\n          <td>FILLED</td>\n          <td>The order has been fully filled and is no longer in the matching queue</td>\n        </tr>\n        <tr>\n          <td>PARTIALLY_CANCELED</td>\n          <td>The order was partially traded, but the remaining quantity was canceled</td>\n        </tr>\n        <tr>\n          <td>PENDING_CANCEL</td>\n          <td>The order was removed from the matching queue and is awaiting fund release to finalize the cancellation</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>The order was completely canceled and has no associated trades</td>\n        </tr>\n      </tbody>\n    </table>","example":"ACTIVE","enum":["ACTIVE","CANCELED","FILLED","PARTIALLY_CANCELED","PARTIALLY_FILLED","PENDING_CANCEL"]},"price":{"type":"string","description":"The limit price, when it is a limit order. On an OCO, the take-profit limit until the\n    stop-loss triggers, then the stop-loss limit","example":"290000.0","nullable":true},"stop_price":{"type":"string","description":"The price that triggers the order, on the order types that carry one; on an OCO, the stop-loss trigger.\n    A trailing stop moves it on its own while the market runs in the order's favour, so\n    what it holds is where the trigger stands now, not where the order was created","example":"240000.0","nullable":true},"price_avg":{"type":"string","description":"The average traded price of the order","example":"295333.3333"},"quantity":{"type":"string","description":"The quantity of this order still to be executed (0.0 once it is filled)","example":"0.42"},"quantity_executed":{"type":"string","description":"The current quantity executed of this order","example":"0.41"},"instant_amount":{"type":"string","description":"The amount intended to execute in this order (for INSTANT orders)","example":"290.0","nullable":true},"instant_amount_executed":{"type":"string","description":"The current amount executed of this order (for INSTANT orders)","example":"290.0","nullable":true},"created_at":{"type":"string","description":"The creation date of this order in ISO-8601 UTC","example":"2021-02-15T22:06:32.999Z"},"trades_count":{"type":"number","description":"The current number of trades executed with this order","example":2},"remark":{"type":"string","description":"A note for the order","example":"A remarkable note for the order.","nullable":true},"fee_paid":{"type":"string","description":"The fee paid for the order execution","example":"0.0"},"post_only":{"type":"boolean","description":"When true, the order only adds liquidity to the market and never matches\n      with orders already on the book","example":false},"time_in_force":{"type":"string","description":"<b>TimeInForce (TIF)</b> defines how long an order remains active before it is executed or canceled.\n    Foxbit currently supports: <br /><b>Good 'til Cancelled (GTC):</b> the order stays active until\n    it is fully filled or canceled manually by the trader;<br /><b>Fill or Kill (FOK):</b> the order must be <b>fully filled immediately</b>.\n    If 100% of the quantity cannot be filled at once, the <b>entire order is canceled</b> (no partial fills);\n    <br /><b>Immediate or Cancel (IOC):</b> any part of the order that can be filled <b>immediately</b> is executed,\n    and <b>any remaining quantity is canceled</b> (allows partial fills, unlike FOK).\n    <br />Only applicable to LIMIT and STOP_LIMIT orders. Default: <b>GTC</b>","example":"GTC","enum":["GTC","FOK","IOC"],"nullable":true},"cancellation_reason":{"type":"number","description":"Indicates the reason for canceling an order.\n      See the <a href=\"https://docs.foxbit.com.br/rest/v3/#tag/API-Codes\">API Codes</a> section for the list of possible cancellation reasons","example":100,"nullable":true},"cancellation_reason_order_id":{"type":"string","description":"ID of the counterparty order that triggered this order's cancellation, when applicable\n      (e.g., for Self Trade Prevention)","example":"12345","nullable":true},"stp":{"type":"string","description":"<b>Self Trade Prevention (STP)</b> is a mechanism employed by trading platforms\n      to prevent users from inadvertently trading against themselves.\n      <br /><b>EXPIRE_TAKER:</b> This mode prevents a trade by immediately revoking the taker order's remaining quantity.\n      <br /><b>EXPIRE_MAKER:</b> This mode prevents a trade by immediately revoking the potential maker order's remaining quantity.\n      <br /><b>EXPIRE_BOTH:</b> This mode prevents a trade by immediately revoking both the taker and maker orders.\n      <br /><b>DECREMENT:</b> This mode prevents a trade by immediately revoking the order with the smaller quantity\n      <br /><b>NONE:</b> Self Trade Prevention is off. Only accounts enabled for it keep it, others get EXPIRE_TAKER","example":"EXPIRE_TAKER","enum":["NONE","EXPIRE_BOTH","EXPIRE_MAKER","EXPIRE_TAKER","DECREMENT"],"nullable":true},"slippage_tolerance":{"type":"string","nullable":true,"description":"The slippage tolerance feature protects users from \n    unexpected price changes during trades, \n    ensuring transactions execute within acceptable limits and enhancing trading accuracy.<br />\n    <b>Must be a decimal string between 0 and 1 with up to 3 decimal places (e.g., 0.025 = 2.5%)</b>","example":"0.025"},"trail_type":{"type":"string","description":"How the trail distance is read: <b>AMOUNT</b> for an absolute value in\n    the quote currency, <b>PERCENT</b> for a percentage of the price the stop trails.\n    Only trailing stop orders carry it","example":"AMOUNT","enum":["AMOUNT","PERCENT"],"nullable":true},"trail_value":{"type":"string","description":"The trail distance the order was created with, read per trail_type","example":"500.0","nullable":true},"limit_offset":{"type":"string","description":"The offset the limit price keeps from the stop price at trigger time.\n    Only a TRAILING_STOP_LIMIT carries it","example":"50.0","nullable":true},"origin_stop_price":{"type":"string","description":"The stop price the trailing stop was created with, before any move.\n    The distance the trail has walked is stop_price minus this one","example":"240000.0","nullable":true},"stop_price_updated_at":{"type":"string","description":"When the matching engine last moved the stop price. Null while the\n    trail has not moved yet","example":"2026-10-07T13:45:12.000Z","nullable":true},"legs":{"description":"The take-profit and stop-loss legs of an OCO order, in that order.\n    Null for any other order type","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OrderLeg"}},"oco_winner_leg":{"type":"string","description":"The leg an OCO order committed to: STOP_LOSS once stop_price triggers,\n    TAKE_PROFIT after a first trade. Null while both legs are active and for any other order type","example":"STOP_LOSS","enum":["TAKE_PROFIT","STOP_LOSS"],"nullable":true}}},"Orders":{"type":"object","properties":{"data":{"description":"The list of orders","type":"array","items":{"$ref":"#/components/schemas/OrderWithoutRemark"}}}},"OrdersCancelAll":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"ALL","enum":["ALL"]}},"required":["type"]},"OrdersCancelSn":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"SN","enum":["SN"]},"sn":{"type":"string","description":"SN of the order","example":"OKMAKSDHRVVREK"}},"required":["type","sn"]},"OrdersCancelId":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"ID","enum":["ID"]},"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"123456789"}},"required":["type","id"]},"OrdersCancelClientOrderId":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"CLIENT_ORDER_ID","enum":["CLIENT_ORDER_ID"]},"client_order_id":{"type":"string","description":"Client-provided numeric identifier (max. of 2^63 - 1) of the order","example":"451637946501"}},"required":["type","client_order_id"]},"OrdersCancelMarket":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"MARKET","enum":["MARKET"]},"market_symbol":{"type":"string","description":"Market to cancel orders","example":"btcbrl"}},"required":["type","market_symbol"]},"OrdersCancelMarketSide":{"type":"object","properties":{"sub_account_type":{"type":"string","description":"The sub-account type to filter orders","enum":["PREDICTION"]},"type":{"type":"string","description":"Type of cancellation request","example":"MARKET_SIDE","enum":["MARKET_SIDE"]},"market_symbol":{"type":"string","description":"Market to cancel orders","example":"btcbrl"},"side":{"type":"string","description":"The order book side to cancel","example":"BUY","enum":["BUY","SELL"]}},"required":["type","market_symbol","side"]},"OrderCanceled":{"type":"object","properties":{"sn":{"type":"string","description":"SN of the order","example":"OKMAKSDHRVVREK"},"id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"123456789"}}},"OrdersCanceled":{"type":"object","properties":{"data":{"description":"The order's SNs and Ids list","type":"array","items":{"$ref":"#/components/schemas/OrderCanceled"}}}},"Trade":{"type":"object","properties":{"id":{"type":"number","description":"Numeric unique identifier of the trade","example":1234567890},"sn":{"type":"string","description":"Alphanumeric unique identifier (Deprecated by property \"id\")","example":"TC5JZVW2LLJ3IW","deprecated":true},"order_id":{"type":"string","description":"Unique identifier of the order, a numeric value sent as a string","example":"1234567890"},"market_symbol":{"type":"string","description":"The market where the trade was created","example":"btcbrl"},"side":{"type":"string","description":"The order book side where the trade was created","example":"BUY","enum":["BUY","SELL"]},"price":{"type":"string","description":"The price at which the trade was executed","example":"290000.0"},"quantity":{"type":"string","description":"The quantity executed in this trade","example":"1.0"},"fee":{"type":"string","description":"The total in fees paid in this trade","example":"0.01"},"fee_currency_symbol":{"type":"string","description":"The currency symbol in which the fees were paid","example":"btc"},"role":{"type":"string","description":"The role in the trade. <b>MAKER</b>: the order was resting on the book and added liquidity;\n      <b>TAKER</b>: the order matched an existing order and removed liquidity","example":"MAKER","enum":["MAKER","TAKER"]},"created_at":{"type":"string","description":"The creation date of this trade in ISO-8601 UTC","example":"2021-02-15T22:06:32.999Z"}}},"Trades":{"type":"object","properties":{"data":{"description":"The list of trades","type":"array","items":{"$ref":"#/components/schemas/Trade"}}}},"SystemTime":{"type":"object","properties":{"iso":{"type":"string","description":"Server time in ISO-8601","example":"2021-06-15T18:00:00.123Z"},"timestamp":{"type":"number","description":"Server time in UNIX Timestamp with milliseconds precision","example":1623780000123}}},"Account":{"type":"object","properties":{"currency_symbol":{"type":"string","description":"Currency of the account","example":"btc"},"balance":{"type":"string","description":"Total balance of the account","example":"10000.0"},"balance_available":{"type":"string","description":"Available balance","example":"9000.0"},"balance_locked":{"type":"string","description":"Locked balance","example":"1000.0"}}},"Accounts":{"type":"object","properties":{"data":{"description":"The accounts","type":"array","items":{"$ref":"#/components/schemas/Account"}}}},"Transaction":{"type":"object","properties":{"uuid":{"type":"string","description":"The transaction unique identifier (UUID)","example":"f8e9f2d6-3c1e-4f2d-8f8e-9f2d6c1e4f2d"},"amount":{"type":"string","description":"The amount of the transaction. If negative, means balance subtraction","example":"0.0001"},"balance":{"type":"string","description":"The balance after the transaction","example":"0.0002"},"created_at":{"type":"string","description":"The date and time when the transaction was created (ISO 8601)","example":"2021-07-01T12:00:00.000Z"},"currency_symbol":{"type":"string","description":"The currency symbol of the transaction","example":"btc"},"fee":{"type":"string","description":"The fee that was charged in this transaction","example":"0.0"},"locked":{"type":"string","description":"The balance that is currently locked","example":"0.0"},"locked_amount":{"type":"string","description":"The locked amount of the transaction. If negative, means balance unlock","example":"0.0"},"reason_type":{"type":"string","description":"The type of the transaction's reason\n    <table>\n      <thead>\n        <tr>\n          <th>Reason</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>DEPOSITING</td>\n          <td>Balance change from a deposit</td>\n        </tr>\n        <tr>\n          <td>WITHDRAWING</td>\n          <td>Balance change from a withdrawal</td>\n        </tr>\n        <tr>\n          <td>TRADING</td>\n          <td>Balance change from a trade execution</td>\n        </tr>\n        <tr>\n          <td>INTERNAL_TRANSFERING</td>\n          <td>Balance change from an internal transfer</td>\n        </tr>\n        <tr>\n          <td>DUST_TRADING</td>\n          <td>Balance change from dust conversion</td>\n        </tr>\n        <tr>\n          <td>OTHERS</td>\n          <td>Other balance changes</td>\n        </tr>\n      </tbody>\n    </table>","example":"DEPOSITING","enum":["DEPOSITING","WITHDRAWING","TRADING","INTERNAL_TRANSFERING","DUST_TRADING","OTHERS"]}},"required":["uuid","amount","balance","created_at","currency_symbol","fee","locked","locked_amount","reason_type"]},"TransactionsResponse":{"type":"object","properties":{"data":{"description":"The list of transactions","type":"array","items":{"$ref":"#/components/schemas/Transaction"}}},"required":["data"]},"DetailsCrypto":{"type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"The Transaction ID on the blockchain","example":"e20f035387020c5d5ea18ad53244f09f34e54fd9967bdf43fc5b2c4e1a7d9f03"},"receiving_address":{"type":"string","description":"The address of the wallet to which the funds were sent","example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},"network_code":{"type":"string","description":"The identifier of the network on which the transaction was executed","example":"bitcoin","nullable":true}}},"DepositTravelRuleSender":{"type":"object","properties":{"name":{"type":"string","description":"Sender's full name; yours on your own wallet","example":"Example Company LLC","nullable":true},"tax_id_number":{"type":"string","description":"Sender's tax ID, always masked, the declaration response included: only a few middle digits are visible (CPF `***.456.***-**`, CNPJ `**.***.678/****-**`, the central third of a TIN)","example":"***456***","nullable":true},"document_type":{"type":"string","description":"Kind of tax ID the sender informed","enum":["CPF","CNPJ","TIN"],"example":"TIN","nullable":true},"person_type":{"type":"string","description":"Third-party sender: natural or legal person","enum":["NATURAL","LEGAL"],"example":"LEGAL","nullable":true},"residence_country":{"type":"string","description":"Residence of the sender, ISO 3166-1 alpha-2","example":"US","nullable":true},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the sender company, as declared: FINANCIAL_INSTITUTION, 05, 71, 78 or 79. `null` unless the sender is a legal person abroad","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05","nullable":true},"institution_type":{"type":"string","description":"Kind of financial institution of the sender, when `entity_category` is `FINANCIAL_INSTITUTION`","enum":["53","56","58","59","60"],"example":null,"nullable":true}},"required":["name","tax_id_number","document_type","person_type","residence_country","entity_category","institution_type"]},"RequiredDocument":{"type":"object","properties":{"title":{"type":"string","description":"Name of the document","example":"Contrato de câmbio"},"description":{"type":"string","description":"What the document is and what it has to show","example":"Contrato assinado pelas duas partes","nullable":true},"requirements":{"description":"Conditions the document must meet","example":["Legível","Dentro da validade"],"type":"array","items":{"type":"string"}}},"required":["title","description","requirements"]},"DepositTravelRuleReview":{"type":"object","properties":{"state":{"type":"string","description":"State of the review\n    <table>\n      <thead><tr><th>State</th><th>Description</th></tr></thead>\n      <tbody>\n        <tr><td>OPEN</td><td>Under review; the deposit stays in AWAITING_TRAVEL_RULE_REVIEW</td></tr>\n        <tr><td>APPROVED</td><td>Approved; the deposit was credited</td></tr>\n        <tr><td>REJECTED</td><td>Reproved; the deposit was rejected</td></tr>\n      </tbody>\n    </table>","enum":["OPEN","APPROVED","REJECTED"],"example":"OPEN"},"round":{"type":"integer","description":"Review round, starting at 1. Null when the round is not informed.","example":1,"nullable":true},"requested_at":{"type":"string","description":"When the review was opened, ISO-8601 UTC","example":"2026-10-19T12:00:05Z","nullable":true}},"required":["state","round","requested_at"]},"DepositTravelRuleDeclaration":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Who holds the origin wallet","enum":["SELF","THIRD_PARTY"],"example":"THIRD_PARTY","nullable":true},"wallet_type":{"type":"string","description":"Origin wallet type. `SELF_HOSTED` is a private/unhosted wallet; `HOSTED` is held at an Exchange/VASP","enum":["SELF_HOSTED","HOSTED"],"example":"HOSTED","nullable":true},"vasp_name":{"type":"string","description":"Name of the origin Exchange/VASP","example":"Example Exchange","nullable":true},"vasp_entity_country":{"type":"string","description":"Country of the origin Exchange/VASP, ISO 3166-1 alpha-2","example":"US","nullable":true},"sender":{"description":"Who sent the deposit. Always present; the fields the path did not ask are `null`. On your own wallet (`wallet_owner` `SELF`) the sender is you: `name`, `tax_id_number` and `document_type` are your own","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleSender"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) the client declared, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil","example":null,"nullable":true},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company, as declared on a path where the client is resident abroad: FINANCIAL_INSTITUTION, 05, 71, 78 or 79","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":null,"nullable":true},"institution_type":{"type":"string","description":"Kind of financial institution of the client, when `entity_category` is `FINANCIAL_INSTITUTION`","enum":["53","56","58","59","60"],"example":null,"nullable":true},"same_economic_group":{"type":"boolean","description":"Whether the client and the sender company belong to the same economic group. `null` unless the sender is a legal person abroad","example":false,"nullable":true},"purpose_description":{"type":"string","description":"Purpose of the transfer in the client's own words","example":"Payment for consulting services","nullable":true},"operation_reason":{"type":"string","description":"BACEN operation reason code, international paths only","example":"32999","nullable":true},"documents_required":{"type":"boolean","description":"Whether the chosen purpose asks the client for documents before the deposit is credited. They are sent through `POST /deposits/{deposit_sn}/travel_rule/documents`","example":false},"required_documents":{"description":"The documents the deposit still waits for, sent in one request through the `travel_rule/documents` endpoint of the deposit. Empty when it waits for none","type":"array","items":{"$ref":"#/components/schemas/RequiredDocument"}},"review":{"description":"Review of the declaration, when there is one. `null` otherwise","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleReview"}]},"created_at":{"type":"string","description":"When the declaration was submitted, ISO-8601 UTC","example":"2026-10-19T12:00:01Z"}},"required":["wallet_owner","wallet_type","vasp_name","vasp_entity_country","sender","fx_residence_country","entity_category","institution_type","same_economic_group","purpose_description","operation_reason","documents_required","required_documents","review","created_at"]},"Deposit":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the deposit","example":"DPKXMRDT7H4VBN"},"state":{"type":"string","description":"The current state of the deposit\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>SUBMITTING</td>\n          <td>Deposit is being submitted to the exchange</td>\n        </tr>\n        <tr>\n          <td>SUBMITTED</td>\n          <td>Deposit submitted and awaiting confirmation</td>\n        </tr>\n        <tr>\n          <td>CANCELLED</td>\n          <td>Deposit was cancelled</td>\n        </tr>\n        <tr>\n          <td>REJECTED</td>\n          <td>Deposit was rejected</td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE</td>\n          <td>Deposit is waiting for Travel Rule information</td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE_REVIEW</td>\n          <td>\n            Deposit declared and under review for the Travel Rule.\n            It may go back to AWAITING_TRAVEL_RULE: send the declaration again, in full. A declaration sent again is always reviewed\n          </td>\n        </tr>\n        <tr>\n          <td>ACCEPTED</td>\n          <td>Deposit accepted and credited to the account</td>\n        </tr>\n        <tr>\n          <td>WARNING</td>\n          <td>Deposit flagged for review</td>\n        </tr>\n        <tr>\n          <td>BLOCKED</td>\n          <td>Deposit blocked</td>\n        </tr>\n        <tr>\n          <td>UNBLOCKED</td>\n          <td>Deposit unblocked after review</td>\n        </tr>\n        <tr>\n          <td>MANUAL_CHARGEBACK_INITIATED</td>\n          <td>A manual chargeback of the deposit was started</td>\n        </tr>\n        <tr>\n          <td>CHARGEDBACK</td>\n          <td>Deposit was charged back</td>\n        </tr>\n      </tbody>\n    </table>","example":"ACCEPTED","enum":["SUBMITTING","CANCELLED","SUBMITTED","REJECTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","ACCEPTED","WARNING","BLOCKED","UNBLOCKED","MANUAL_CHARGEBACK_INITIATED","CHARGEDBACK"]},"currency_symbol":{"type":"string","description":"The currency of the deposit","example":"btc"},"amount":{"type":"string","description":"The amount of the deposit","example":"1.0"},"fee":{"type":"string","description":"The fee of the deposit","example":"0.1"},"created_at":{"type":"string","description":"The creation date of the deposit in ISO-8601 UTC","example":"2022-02-18T22:06:32.999Z"},"details_crypto":{"description":"The details of the transaction","allOf":[{"$ref":"#/components/schemas/DetailsCrypto"}]},"travel_rule":{"description":"Travel Rule declaration of the deposit, the same shape as the withdrawal one. Returned only for crypto deposits: omitted for fiat deposits and `null` while the deposit was never declared. Where the Travel Rule step stands is read from `state`, `documents_required` and `review`. The `sender.tax_id_number` is masked, revealing only a few middle digits (e.g. CPF `***.456.***-**`)","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleDeclaration"}]}}},"Deposits":{"type":"object","properties":{"data":{"description":"The deposits list","type":"array","items":{"$ref":"#/components/schemas/Deposit"}}}},"DepositTravelRuleOwnPrivateWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"The client holds the origin wallet","enum":["SELF"],"example":"SELF"},"wallet_type":{"type":"string","description":"A private (unhosted) wallet","enum":["SELF_HOSTED"],"example":"SELF_HOSTED"},"purpose_description":{"type":"string","description":"Purpose of the deposit in the client's own words. Mandatory above USD 50,000 (Annex IV); ignored up to it","example":"Payment for consulting services"}},"required":["wallet_owner","wallet_type"]},"DepositTravelRuleOwnExchangeWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"The client holds the origin wallet","enum":["SELF"],"example":"SELF"},"wallet_type":{"type":"string","description":"An account at an Exchange/VASP","enum":["HOSTED"],"example":"HOSTED"},"vasp_name":{"type":"string","description":"Name of the origin Exchange/VASP","example":"Example Exchange"},"vasp_entity_country":{"type":"string","description":"Country of the origin Exchange/VASP, ISO 3166-1 alpha-2. `BR` for an Exchange/VASP in Brazil","example":"BR"},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"purpose_description":{"type":"string","description":"Purpose of the deposit in the client's own words. Mandatory when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`) and the amount is above USD 50,000; ignored otherwise","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the deposit. Mandatory when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`); ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","vasp_name","vasp_entity_country"]},"DepositTravelRuleSenderInput":{"type":"object","properties":{"person_type":{"type":"string","description":"Whether the sender is a natural or a legal person","enum":["NATURAL","LEGAL"],"example":"NATURAL"},"name":{"type":"string","description":"Full name of the sender","example":"Jane Doe"},"tax_id_number":{"type":"string","description":"Tax ID of the sender: CPF/CNPJ (digits, mask accepted) or a foreign TIN. A CPF or CNPJ with an invalid check digit answers 422","example":"52998224725"},"residence_country":{"type":"string","description":"Country of residence of the sender, ISO 3166-1 alpha-2. `BR` for a sender in Brazil","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the sender company. Required when `person_type` is `LEGAL` and the sender is abroad (`sender.residence_country` other than `BR`); ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the sender. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"}},"required":["person_type","name","tax_id_number","residence_country"]},"DepositTravelRuleThirdPartyPrivateWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Someone other than the client holds the origin wallet","enum":["THIRD_PARTY"],"example":"THIRD_PARTY"},"wallet_type":{"type":"string","description":"A private (unhosted) wallet","enum":["SELF_HOSTED"],"example":"SELF_HOSTED"},"sender":{"description":"Who sent the deposit","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleSenderInput"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the sender is in Brazil (`sender.residence_country` is `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the sender is in Brazil (`sender.residence_country` is `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"same_economic_group":{"type":"boolean","description":"Whether the client and the sender company belong to the same economic group. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the sender is abroad (`sender.residence_country` other than `BR`) and `sender.person_type` is `LEGAL`; ignored otherwise","example":false},"purpose_description":{"type":"string","description":"Purpose of the deposit in the client's own words. Mandatory above USD 50,000 (Annex IV); ignored up to it","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the deposit. Mandatory when the sender is abroad (`sender.residence_country` other than `BR`) or `fx_residence_country` is other than `BR`; ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","sender"]},"DepositTravelRuleThirdPartyExchangeWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Someone other than the client holds the origin wallet","enum":["THIRD_PARTY"],"example":"THIRD_PARTY"},"wallet_type":{"type":"string","description":"An account at an Exchange/VASP","enum":["HOSTED"],"example":"HOSTED"},"vasp_name":{"type":"string","description":"Name of the origin Exchange/VASP","example":"Example Exchange"},"vasp_entity_country":{"type":"string","description":"Country of the origin Exchange/VASP, ISO 3166-1 alpha-2. `BR` for an Exchange/VASP in Brazil. Mandatory when the sender is abroad (`sender.residence_country` other than `BR`); ignored otherwise","example":"US"},"sender":{"description":"Who sent the deposit","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleSenderInput"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the sender is in Brazil (`sender.residence_country` is `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the sender is in Brazil (`sender.residence_country` is `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"same_economic_group":{"type":"boolean","description":"Whether the client and the sender company belong to the same economic group. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the sender is abroad (`sender.residence_country` other than `BR`) and `sender.person_type` is `LEGAL`; ignored otherwise","example":false},"purpose_description":{"type":"string","description":"Purpose of the deposit in the client's own words. Mandatory above USD 50,000 unless the sender is in Brazil (`sender.residence_country` is `BR`) and the client is resident in Brazil, where it is ignored","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the deposit. Mandatory when the sender is abroad (`sender.residence_country` other than `BR`) or `fx_residence_country` is other than `BR`; ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","vasp_name","sender"]},"DepositTravelRuleSubmitted":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the deposit","example":"DPKXMRDT7H4VBN"},"state":{"type":"string","description":"Deposit state after the submission. `ACCEPTED` when credited, `AWAITING_TRAVEL_RULE` while documents are pending, `AWAITING_TRAVEL_RULE_REVIEW` under review","enum":["SUBMITTING","CANCELLED","SUBMITTED","REJECTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","ACCEPTED","WARNING","BLOCKED","UNBLOCKED","MANUAL_CHARGEBACK_INITIATED","CHARGEDBACK"],"example":"AWAITING_TRAVEL_RULE_REVIEW"},"documents_required":{"type":"boolean","description":"The purpose asks for documents before the deposit is credited: send them through the `travel_rule/documents` endpoint of the deposit, which stays in `AWAITING_TRAVEL_RULE` meanwhile. Which ones is `travel_rule.required_documents`","example":false},"travel_rule":{"description":"The declaration as persisted, the same shape the deposit reads return, with `sender.tax_id_number` masked","allOf":[{"$ref":"#/components/schemas/DepositTravelRuleDeclaration"}]}},"required":["sn","state","documents_required","travel_rule"]},"TravelRuleDeclarationError":{"type":"object","properties":{"message":{"type":"string","description":"What kind of error happened","example":"Bad request."},"code":{"type":"number","description":"Numeric code of the error: `400` for an invalid body, `422` for an operation that cannot take the declaration, `4001` when the declaration itself is refused (a field the account type does not take, an invalid CPF/CNPJ, a purpose not accepted, the purpose description missing above USD 50,000)","example":400},"details":{"description":"Every problem found; one about the body names the field","example":["purpose_description is required for this declaration"],"type":"array","items":{"type":"string"}}},"required":["message","code","details"]},"TravelRuleDeclarationErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/TravelRuleDeclarationError"}},"required":["error"]},"DepositTravelRuleOperationReason":{"type":"object","properties":{"code":{"type":"string","description":"BACEN operation reason code: the `operation_reason` of a withdrawal or deposit Travel Rule declaration","example":"32999"},"description":{"type":"string","description":"Human-readable, localized description of the operation reason","example":"International travel"},"requires_documents":{"type":"boolean","description":"Choosing this reason asks the client for documents before the deposit is credited, sent through the `travel_rule/documents` endpoint of the deposit","example":false},"required_documents":{"description":"The documents this reason asks for, empty when it asks for none. After the declaration, the declaration of the operation lists the ones still pending in its `required_documents`","type":"array","items":{"$ref":"#/components/schemas/RequiredDocument"}}},"required":["code","description","requires_documents","required_documents"]},"DepositTravelRuleOperationReasons":{"type":"object","properties":{"data":{"description":"The operation reasons (purposes) the Travel Rule declaration of this deposit accepts","type":"array","items":{"$ref":"#/components/schemas/DepositTravelRuleOperationReason"}}},"required":["data"]},"CurrencyNetwork":{"type":"object","properties":{"name":{"type":"string","description":"Name of the currency's network","example":"Bitcoin Network"},"code":{"type":"string","description":"Code of the currency's network","example":"bitcoin"}}},"DepositAddress":{"type":"object","properties":{"currency_symbol":{"type":"string","description":"Currency of the wallet","example":"btc","nullable":true},"address":{"type":"string","nullable":true,"description":"Address of the wallet","example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},"message":{"type":"string","description":"Status message of the response","example":"Address was retrieved successfully"},"destination_tag":{"type":"string","description":"Destination tag used by crypto, empty for a currency without tags","example":""},"network":{"nullable":true,"description":"Network of the currency","type":"object","allOf":[{"$ref":"#/components/schemas/CurrencyNetwork"}]}}},"DepositTravelRuleDocumentsSubmitted":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the deposit","example":"DPKXMRDT7H4VBN"},"state":{"type":"string","description":"Deposit state after the documents were attached. `AWAITING_TRAVEL_RULE_REVIEW` when the deposit is under review, `ACCEPTED` when the deposit was credited","enum":["SUBMITTING","CANCELLED","SUBMITTED","REJECTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","ACCEPTED","WARNING","BLOCKED","UNBLOCKED","MANUAL_CHARGEBACK_INITIATED","CHARGEDBACK"],"example":"AWAITING_TRAVEL_RULE_REVIEW"},"case_state":{"type":"string","description":"State of the document request after the submission","example":"UNDER_REVIEW"}},"required":["sn","state","case_state"]},"DetailsWithdrawCrypto":{"type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"The Transaction ID on the blockchain","example":"e20f035387020c5d5ea18ad53244f09f34e54fd9967bdf43fc5b2c4e1a7d9f03"},"destination_address":{"type":"string","description":"The address of the wallet to which the funds were sent \n    (The destination tag currently appended to the address will be deprecated soon. Please use the destination_tag field instead.)","example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},"network_code":{"type":"string","nullable":true,"description":"The identifier of the network on which the transaction was executed","example":"bitcoin"},"destination_tag":{"type":"string","nullable":true,"description":"The identifier required for withdrawals to shared wallet addresses (e.g., XRP, XLM)","example":"87569"}}},"BankBranch":{"type":"object","properties":{"number":{"type":"string","description":"Branch number","example":"1234567890"},"digit":{"type":"string","description":"Branch check digit","example":null,"nullable":true,"deprecated":true}},"required":["number"]},"BankAccount":{"type":"object","properties":{"number":{"type":"string","description":"Account number","example":"1234567890"},"digit":{"type":"string","description":"Account check digit","example":"1"},"type":{"type":"string","description":"Account type","enum":["CHECK","SAVINGS"],"example":"CHECK"}},"required":["number","digit","type"]},"BankAccountData":{"type":"object","properties":{"code":{"type":"string","description":"Bank code (as in https://docs.foxbit.com.br/rest/v3/#tag/Banks)","example":"1"},"branch":{"description":"Bank branch data","allOf":[{"$ref":"#/components/schemas/BankBranch"}]},"account":{"description":"Bank account data","allOf":[{"$ref":"#/components/schemas/BankAccount"}]}},"required":["code","branch","account"]},"BankData":{"type":"object","properties":{"bank":{"description":"The details of the transaction.","example":{"code":"001","branch":{"number":"1234","digit":null},"account":{"number":"1234567890","digit":"1","type":"CHECK"}},"allOf":[{"$ref":"#/components/schemas/BankAccountData"}]}},"required":["bank"]},"WithdrawalList":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the withdrawal","example":"WDRZN4HKGT8MBP"},"state":{"type":"string","description":"The current state of the withdrawal\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>SUBMITTING</td>\n          <td>Withdrawal is being submitted</td>\n        </tr>\n        <tr>\n          <td>SUBMITTED</td>\n          <td>Withdrawal submitted and awaiting processing</td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE</td>\n          <td>Waiting for Travel Rule information</td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE_REVIEW</td>\n          <td>\n            Travel Rule declaration under review.\n            It may go back to AWAITING_TRAVEL_RULE: send the declaration again, in full. A declaration sent again is always reviewed\n          </td>\n        </tr>\n        <tr>\n          <td>PROCESSING</td>\n          <td>Withdrawal is being processed</td>\n        </tr>\n        <tr>\n          <td>DONE</td>\n          <td>Withdrawal completed</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>Withdrawal canceled</td>\n        </tr>\n        <tr>\n          <td>REJECTED</td>\n          <td>Withdrawal rejected — see rejection_reason</td>\n        </tr>\n        <tr>\n          <td>FAILED</td>\n          <td>Withdrawal failed</td>\n        </tr>\n      </tbody>\n    </table>","example":"DONE","enum":["SUBMITTING","SUBMITTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","PROCESSING","CANCELED","REJECTED","FAILED","DONE"]},"rejection_reason":{"type":"string","description":"The current rejection reason of the withdrawal\n    <table>\n      <thead>\n        <tr>\n          <th>Reason</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>MONTHLY_LIMIT_EXCEEDED</td>\n          <td>The monthly withdrawal limit was exceeded</td>\n        </tr>\n        <tr>\n          <td>DIFFERENT_TITULARITY</td>\n          <td>Destination account belongs to a different owner</td>\n        </tr>\n        <tr>\n          <td>SYSTEM_FAILURE</td>\n          <td>An internal error occurred</td>\n        </tr>\n        <tr>\n          <td>WALLET_ADDRESS_NOT_VALID</td>\n          <td>Destination wallet address is invalid</td>\n        </tr>\n        <tr>\n          <td>WALLET_ADDRESS_SAME_OWNER</td>\n          <td>Destination wallet belongs to the same owner</td>\n        </tr>\n        <tr>\n          <td>KYC_VALIDATION_FAILED</td>\n          <td>Identity (KYC) validation failed</td>\n        </tr>\n        <tr>\n          <td>KYC_SYNC_FAILED</td>\n          <td>Identity (KYC) data could not be synchronized</td>\n        </tr>\n        <tr>\n          <td>SECURITY_VALIDATION_FAILED</td>\n          <td>Security validation failed</td>\n        </tr>\n        <tr>\n          <td>BLOCKED_ADDRESS</td>\n          <td>Destination wallet address is blocked</td>\n        </tr>\n        <tr>\n          <td>OPERATIONAL_LIMIT_EXCEEDED</td>\n          <td>An operational limit of the platform was exceeded</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_REJECTED</td>\n          <td>The Travel Rule declaration was rejected; funds returned</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_COUNTRY_RESTRICTED</td>\n          <td>The Travel Rule declaration was not accepted; funds returned</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_LIMIT_EXCEEDED</td>\n          <td>The amount exceeds the Travel Rule limit; funds returned</td>\n        </tr>\n      </tbody>\n    </table>","example":"MONTHLY_LIMIT_EXCEEDED","enum":["MONTHLY_LIMIT_EXCEEDED","DIFFERENT_TITULARITY","SYSTEM_FAILURE","WALLET_ADDRESS_NOT_VALID","WALLET_ADDRESS_SAME_OWNER","KYC_VALIDATION_FAILED","KYC_SYNC_FAILED","SECURITY_VALIDATION_FAILED","BLOCKED_ADDRESS","OPERATIONAL_LIMIT_EXCEEDED","TRAVEL_RULE_REJECTED","TRAVEL_RULE_COUNTRY_RESTRICTED","TRAVEL_RULE_LIMIT_EXCEEDED"],"nullable":true},"currency_symbol":{"type":"string","description":"The currency of the withdrawal","example":"btc"},"amount":{"type":"string","description":"The amount of the withdrawal","example":"1.0"},"fee":{"type":"string","description":"The fee of the withdrawal","example":"0.1"},"created_at":{"type":"string","description":"The creation date of the withdrawal in ISO-8601 UTC","example":"2022-02-18T22:06:32.999Z"},"details_crypto":{"description":"The details of the transaction","allOf":[{"$ref":"#/components/schemas/DetailsWithdrawCrypto"}]},"details_fiat":{"description":"Bank account details of the fiat withdrawal","allOf":[{"$ref":"#/components/schemas/BankData"}]}}},"Withdrawals":{"type":"object","properties":{"data":{"description":"The withdrawals list","type":"array","items":{"$ref":"#/components/schemas/WithdrawalList"}}}},"DetailsWithdrawCryptoTag":{"type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"The Transaction ID on the blockchain","example":"e20f035387020c5d5ea18ad53244f09f34e54fd9967bdf43fc5b2c4e1a7d9f03"},"destination_address":{"type":"string","description":"The address of the wallet to which the funds were sent","example":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"},"destination_tag":{"type":"string","nullable":true,"description":"The identifier required for withdrawals to shared wallet addresses (e.g., XRP, XLM)","example":"456"},"network_code":{"type":"string","nullable":true,"description":"The identifier of the network on which the transaction was executed","example":"bitcoin"}}},"WithdrawalTravelRuleRecipient":{"type":"object","properties":{"name":{"type":"string","description":"Recipient's full name; yours on your own wallet","example":"Jane Doe","nullable":true},"tax_id_number":{"type":"string","description":"Third-party recipient's tax ID, always masked, the declaration response included: only a few middle digits are visible (CPF `***.456.***-**`, CNPJ `**.***.678/****-**`, the central third of a TIN)","example":"***456***","nullable":true},"document_type":{"type":"string","description":"Kind of tax ID the recipient informed","enum":["CPF","CNPJ","TIN"],"example":"TIN","nullable":true},"person_type":{"type":"string","description":"Third-party recipient: natural or legal person","enum":["NATURAL","LEGAL"],"example":"NATURAL","nullable":true},"residence_country":{"type":"string","description":"Residence of the third-party recipient, ISO 3166-1 alpha-2","example":"US","nullable":true},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the recipient company, as declared: FINANCIAL_INSTITUTION, 05, 71, 78 or 79. `null` unless the recipient is a legal person abroad","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":null,"nullable":true},"institution_type":{"type":"string","description":"Kind of financial institution of the recipient, when `entity_category` is `FINANCIAL_INSTITUTION`","enum":["53","56","58","59","60"],"example":null,"nullable":true}},"required":["name","tax_id_number","document_type","person_type","residence_country","entity_category","institution_type"]},"WithdrawalTravelRuleReview":{"type":"object","properties":{"state":{"type":"string","description":"State of the review\n    <table>\n      <thead><tr><th>State</th><th>Description</th></tr></thead>\n      <tbody>\n        <tr><td>OPEN</td><td>Under review; the withdrawal stays in AWAITING_TRAVEL_RULE_REVIEW</td></tr>\n        <tr><td>APPROVED</td><td>Approved; the withdrawal followed the standard flow</td></tr>\n        <tr><td>REJECTED</td><td>Reproved; the withdrawal was rejected with TRAVEL_RULE_REJECTED and the funds returned</td></tr>\n      </tbody>\n    </table>","enum":["OPEN","APPROVED","REJECTED"],"example":"OPEN"},"round":{"type":"integer","description":"Review round, starting at 1. Null when the round is not informed.","example":1,"nullable":true},"requested_at":{"type":"string","description":"When the review was opened, ISO-8601 UTC","example":"2026-09-21T12:00:05Z","nullable":true}},"required":["state","round","requested_at"]},"WithdrawalTravelRuleDeclaration":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Who holds the destination wallet","enum":["SELF","THIRD_PARTY"],"example":"THIRD_PARTY","nullable":true},"wallet_type":{"type":"string","description":"Destination wallet type. `SELF_HOSTED` is a private/unhosted wallet; `HOSTED` is held at an Exchange/VASP","enum":["SELF_HOSTED","HOSTED"],"example":"HOSTED","nullable":true},"vasp_name":{"type":"string","description":"Name of the destination Exchange/VASP","example":"Example Exchange","nullable":true},"vasp_entity_country":{"type":"string","description":"Country of the destination Exchange/VASP, ISO 3166-1 alpha-2","example":"US","nullable":true},"recipient":{"description":"Who receives the withdrawal. Always present; the fields the path did not ask are `null`. On your own wallet (`wallet_owner` `SELF`) the recipient is you: `name`, `tax_id_number` and `document_type` are your own","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleRecipient"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) the client declared, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil","example":null,"nullable":true},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company, as declared on a path where the client is resident abroad: FINANCIAL_INSTITUTION, 05, 71, 78 or 79","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":null,"nullable":true},"institution_type":{"type":"string","description":"Kind of financial institution of the client, when `entity_category` is `FINANCIAL_INSTITUTION`","enum":["53","56","58","59","60"],"example":null,"nullable":true},"same_economic_group":{"type":"boolean","description":"Whether the client and the recipient company belong to the same economic group. `null` unless the recipient is a legal person abroad","example":null,"nullable":true},"purpose_description":{"type":"string","description":"Purpose of the transfer in the client's own words","example":"Gift to a relative","nullable":true},"operation_reason":{"type":"string","description":"BACEN operation reason code, international paths only","example":"37994","nullable":true},"documents_required":{"type":"boolean","description":"Whether the chosen purpose asks the client for documents before the withdrawal proceeds. They are sent through `POST /withdrawals/{withdrawal_sn}/travel_rule/documents`","example":false},"required_documents":{"description":"The documents the withdrawal still waits for, sent in one request through the `travel_rule/documents` endpoint of the withdrawal. Empty when it waits for none","type":"array","items":{"$ref":"#/components/schemas/RequiredDocument"}},"review":{"description":"Review of the declaration, when there is one. `null` otherwise","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleReview"}]},"created_at":{"type":"string","description":"When the declaration was submitted, ISO-8601 UTC","example":"2026-09-21T12:00:01Z"}},"required":["wallet_owner","wallet_type","vasp_name","vasp_entity_country","recipient","fx_residence_country","entity_category","institution_type","same_economic_group","purpose_description","operation_reason","documents_required","required_documents","review","created_at"]},"Withdrawal":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the withdrawal","example":"WDRZN4HKGT8MBP"},"state":{"type":"string","description":"The current state of the withdrawal\n    <table>\n      <thead>\n        <tr>\n          <th>State</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>SUBMITTING</td>\n          <td>Withdrawal is being submitted</td>\n        </tr>\n        <tr>\n          <td>SUBMITTED</td>\n          <td>Withdrawal submitted and awaiting processing</td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE</td>\n          <td>Waiting for the Travel Rule declaration — submit it via <code>POST /withdrawals/{withdrawal_sn}/travel_rule</code></td>\n        </tr>\n        <tr>\n          <td>AWAITING_TRAVEL_RULE_REVIEW</td>\n          <td>\n            Travel Rule declaration under review; the withdrawal is then released or rejected (funds returned).\n            It may go back to AWAITING_TRAVEL_RULE: send the declaration again, in full. A declaration sent again is always reviewed\n          </td>\n        </tr>\n        <tr>\n          <td>PROCESSING</td>\n          <td>Withdrawal is being processed</td>\n        </tr>\n        <tr>\n          <td>DONE</td>\n          <td>Withdrawal completed</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>Withdrawal canceled</td>\n        </tr>\n        <tr>\n          <td>REJECTED</td>\n          <td>Withdrawal rejected — see rejection_reason</td>\n        </tr>\n        <tr>\n          <td>FAILED</td>\n          <td>Withdrawal failed</td>\n        </tr>\n      </tbody>\n    </table>","example":"DONE","enum":["SUBMITTING","SUBMITTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","PROCESSING","CANCELED","REJECTED","FAILED","DONE"]},"rejection_reason":{"type":"string","description":"The current rejection reason of the withdrawal\n    <table>\n      <thead>\n        <tr>\n          <th>Reason</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>MONTHLY_LIMIT_EXCEEDED</td>\n          <td>The monthly withdrawal limit was exceeded</td>\n        </tr>\n        <tr>\n          <td>DIFFERENT_TITULARITY</td>\n          <td>Destination account belongs to a different owner</td>\n        </tr>\n        <tr>\n          <td>SYSTEM_FAILURE</td>\n          <td>An internal error occurred</td>\n        </tr>\n        <tr>\n          <td>WALLET_ADDRESS_NOT_VALID</td>\n          <td>Destination wallet address is invalid</td>\n        </tr>\n        <tr>\n          <td>WALLET_ADDRESS_SAME_OWNER</td>\n          <td>Destination wallet belongs to the same owner</td>\n        </tr>\n        <tr>\n          <td>KYC_VALIDATION_FAILED</td>\n          <td>Identity (KYC) validation failed</td>\n        </tr>\n        <tr>\n          <td>KYC_SYNC_FAILED</td>\n          <td>Identity (KYC) data could not be synchronized</td>\n        </tr>\n        <tr>\n          <td>SECURITY_VALIDATION_FAILED</td>\n          <td>Security validation failed</td>\n        </tr>\n        <tr>\n          <td>BLOCKED_ADDRESS</td>\n          <td>Destination wallet address is blocked</td>\n        </tr>\n        <tr>\n          <td>OPERATIONAL_LIMIT_EXCEEDED</td>\n          <td>An operational limit of the platform was exceeded</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_REJECTED</td>\n          <td>The Travel Rule declaration was rejected; funds returned</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_COUNTRY_RESTRICTED</td>\n          <td>The Travel Rule declaration was not accepted; funds returned</td>\n        </tr>\n        <tr>\n          <td>TRAVEL_RULE_LIMIT_EXCEEDED</td>\n          <td>The amount exceeds the Travel Rule limit; funds returned</td>\n        </tr>\n      </tbody>\n    </table>","example":"MONTHLY_LIMIT_EXCEEDED","enum":["MONTHLY_LIMIT_EXCEEDED","DIFFERENT_TITULARITY","SYSTEM_FAILURE","WALLET_ADDRESS_NOT_VALID","WALLET_ADDRESS_SAME_OWNER","KYC_VALIDATION_FAILED","KYC_SYNC_FAILED","SECURITY_VALIDATION_FAILED","BLOCKED_ADDRESS","OPERATIONAL_LIMIT_EXCEEDED","TRAVEL_RULE_REJECTED","TRAVEL_RULE_COUNTRY_RESTRICTED","TRAVEL_RULE_LIMIT_EXCEEDED"],"nullable":true},"currency_symbol":{"type":"string","description":"The currency of the withdrawal","example":"btc"},"amount":{"type":"string","description":"The amount of the withdrawal","example":"1.0"},"fee":{"type":"string","description":"The fee of the withdrawal","example":"0.1"},"created_at":{"type":"string","description":"The creation date of the withdrawal in ISO-8601 UTC","example":"2022-02-18T22:06:32.999Z"},"details_crypto":{"description":"The details of the transaction","allOf":[{"$ref":"#/components/schemas/DetailsWithdrawCryptoTag"}]},"travel_rule":{"description":"Travel Rule declaration persisted for the withdrawal: omitted for fiat and `null` when no declaration is recorded. The `recipient.tax_id_number` is masked here, revealing only a few middle digits (e.g. CPF `***.456.***-**`)","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleDeclaration"}]},"details_fiat":{"description":"Bank account details of the fiat withdrawal","allOf":[{"$ref":"#/components/schemas/BankData"}]}}},"WithdrawalFiat":{"type":"object","properties":{"amount":{"type":"string","description":"The amount to be withdrawn","example":"1"},"currency_symbol":{"type":"string","description":"Currency symbol","example":"brl"},"bank":{"description":"Bank branch data","allOf":[{"$ref":"#/components/schemas/BankAccountData"}]}},"required":["amount","currency_symbol","bank"]},"WithdrawalCrypto":{"type":"object","properties":{"amount":{"type":"string","description":"The amount to be withdrawn","example":"1"},"currency_symbol":{"type":"string","description":"Currency symbol","example":"xrp"},"network_code":{"type":"string","description":"Wallet network. If not provided, network_code will default to the default_network_code\n      from the currencies list. To see the default network and all available networks for each currency,\n      check our <a href=\"https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/list-currencies\">currencies list</a> endpoint","example":"ripple"},"destination_address":{"type":"string","description":"Destination wallet address","example":"rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe"},"destination_tag":{"type":"string","description":"Destination tag, required when the network uses one (`has_destination_tag` of the network in the currencies list)","example":"123456"}},"required":["amount","currency_symbol","destination_address"]},"WithdrawalCreated":{"type":"object","properties":{"sn":{"type":"string","description":"Withdrawal SN","example":"WBZYUBF73C4GUU"},"state":{"type":"string","description":"Withdrawal state. A crypto withdrawal that requires the Travel Rule declaration is created in `AWAITING_TRAVEL_RULE`: submit it via `POST /withdrawals/{withdrawal_sn}/travel_rule`","enum":["SUBMITTING","SUBMITTED","AWAITING_TRAVEL_RULE"],"example":"SUBMITTED"},"currency_symbol":{"type":"string","description":"Withdrawal currency symbol","example":"brl"},"amount":{"type":"string","description":"Withdrawal amount","example":"0.5"},"fee":{"type":"string","description":"Withdrawal fee","example":"0.5"},"created_at":{"type":"string","description":"Withdrawal creation date in ISO-8601 UTC","example":"2022-09-15T12:38:18.510Z"},"details_fiat":{"description":"Details from account","allOf":[{"$ref":"#/components/schemas/BankData"}]},"details_crypto":{"description":"The details of the transaction","allOf":[{"$ref":"#/components/schemas/DetailsWithdrawCryptoTag"}]}}},"WithdrawalTravelRuleOwnPrivateWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"The client holds the destination wallet","enum":["SELF"],"example":"SELF"},"wallet_type":{"type":"string","description":"A private (unhosted) wallet","enum":["SELF_HOSTED"],"example":"SELF_HOSTED"},"purpose_description":{"type":"string","description":"Purpose of the withdrawal in the client's own words. Mandatory above USD 50,000 (Annex IV); ignored up to it","example":"Payment for consulting services"}},"required":["wallet_owner","wallet_type"]},"WithdrawalTravelRuleOwnExchangeWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"The client holds the destination wallet","enum":["SELF"],"example":"SELF"},"wallet_type":{"type":"string","description":"An account at an Exchange/VASP","enum":["HOSTED"],"example":"HOSTED"},"vasp_name":{"type":"string","description":"Name of the destination Exchange/VASP","example":"Example Exchange"},"vasp_entity_country":{"type":"string","description":"Country of the destination Exchange/VASP, ISO 3166-1 alpha-2. `BR` for an Exchange/VASP in Brazil","example":"BR"},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"purpose_description":{"type":"string","description":"Purpose of the withdrawal in the client's own words. Mandatory when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`) and the amount is above USD 50,000; ignored otherwise","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the withdrawal. Mandatory when the Exchange/VASP is abroad (`vasp_entity_country` other than `BR`); ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","vasp_name","vasp_entity_country"]},"WithdrawalTravelRuleRecipientInput":{"type":"object","properties":{"person_type":{"type":"string","description":"Whether the recipient is a natural or a legal person","enum":["NATURAL","LEGAL"],"example":"NATURAL"},"name":{"type":"string","description":"Full name of the recipient","example":"Jane Doe"},"tax_id_number":{"type":"string","description":"Tax ID of the recipient: CPF/CNPJ (digits, mask accepted) or a foreign TIN. A CPF or CNPJ with an invalid check digit answers 422","example":"52998224725"},"residence_country":{"type":"string","description":"Country of residence of the recipient, ISO 3166-1 alpha-2. `BR` for a recipient in Brazil","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the recipient company. Required when `person_type` is `LEGAL` and the recipient is abroad (`recipient.residence_country` other than `BR`); ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the recipient. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"}},"required":["person_type","name","tax_id_number","residence_country"]},"WithdrawalTravelRuleThirdPartyPrivateWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Someone other than the client holds the destination wallet","enum":["THIRD_PARTY"],"example":"THIRD_PARTY"},"wallet_type":{"type":"string","description":"A private (unhosted) wallet","enum":["SELF_HOSTED"],"example":"SELF_HOSTED"},"recipient":{"description":"Who receives the withdrawal","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleRecipientInput"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the recipient is in Brazil (`recipient.residence_country` is `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the recipient is in Brazil (`recipient.residence_country` is `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"same_economic_group":{"type":"boolean","description":"Whether the client and the recipient company belong to the same economic group. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the recipient is abroad (`recipient.residence_country` other than `BR`) and `recipient.person_type` is `LEGAL`; ignored otherwise","example":false},"purpose_description":{"type":"string","description":"Purpose of the withdrawal in the client's own words. Mandatory above USD 50,000 (Annex IV); ignored up to it","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the withdrawal. Mandatory when the recipient is abroad (`recipient.residence_country` other than `BR`) or `fx_residence_country` is other than `BR`; ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","recipient"]},"WithdrawalTravelRuleThirdPartyExchangeWallet":{"type":"object","properties":{"wallet_owner":{"type":"string","description":"Someone other than the client holds the destination wallet","enum":["THIRD_PARTY"],"example":"THIRD_PARTY"},"wallet_type":{"type":"string","description":"An account at an Exchange/VASP","enum":["HOSTED"],"example":"HOSTED"},"vasp_name":{"type":"string","description":"Name of the destination Exchange/VASP","example":"Example Exchange"},"vasp_entity_country":{"type":"string","description":"Country of the destination Exchange/VASP, ISO 3166-1 alpha-2. `BR` for an Exchange/VASP in Brazil. Mandatory when the recipient is abroad (`recipient.residence_country` other than `BR`); ignored otherwise","example":"US"},"recipient":{"description":"Who receives the withdrawal","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleRecipientInput"}]},"fx_residence_country":{"type":"string","description":"Exchange residence (Res. BCB 280) of the client, ISO 3166-1 alpha-2. `BR` when the client is resident in Brazil, the default when omitted. Accepted when the recipient is in Brazil (`recipient.residence_country` is `BR`); ignored otherwise","example":"BR"},"entity_category":{"type":"string","description":"Res. BCB 277 Annex VI nature of the client company. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the recipient is in Brazil (`recipient.residence_country` is `BR`) and `fx_residence_country` is other than `BR`; ignored otherwise","enum":["FINANCIAL_INSTITUTION","05","71","78","79"],"example":"05"},"institution_type":{"type":"string","description":"Kind of financial institution of the client company. Required when `entity_category` is `FINANCIAL_INSTITUTION`; ignored otherwise","enum":["53","56","58","59","60"],"example":"53"},"same_economic_group":{"type":"boolean","description":"Whether the client and the recipient company belong to the same economic group. Company accounts only: required for a company account on the path below, refused with 422 for a personal account. Asked when the recipient is abroad (`recipient.residence_country` other than `BR`) and `recipient.person_type` is `LEGAL`; ignored otherwise","example":false},"purpose_description":{"type":"string","description":"Purpose of the withdrawal in the client's own words. Mandatory above USD 50,000 unless the recipient is in Brazil (`recipient.residence_country` is `BR`) and the client is resident in Brazil, where it is ignored","example":"Payment for consulting services"},"operation_reason":{"type":"string","description":"BACEN operation reason code, from the `travel_rule/operation_reasons` endpoint of the withdrawal. Mandatory when the recipient is abroad (`recipient.residence_country` other than `BR`) or `fx_residence_country` is other than `BR`; ignored otherwise","example":"32999"}},"required":["wallet_owner","wallet_type","vasp_name","recipient"]},"WithdrawalTravelRuleSubmitted":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the withdrawal","example":"WDRZN4HKGT8MBP"},"state":{"type":"string","description":"Withdrawal state after the submission; the withdrawal is already confirmed when it is declared. `PROCESSING` when released, `AWAITING_TRAVEL_RULE` while documents are pending, `AWAITING_TRAVEL_RULE_REVIEW` under review. A declaration that rejects the withdrawal does not reach this response: it answers `422` and the withdrawal ends `REJECTED` with the funds returned, which the withdrawal read reports in `rejection_reason`","enum":["SUBMITTING","SUBMITTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","PROCESSING","CANCELED","REJECTED","FAILED","DONE"],"example":"AWAITING_TRAVEL_RULE_REVIEW"},"documents_required":{"type":"boolean","description":"The purpose asks for documents before the withdrawal proceeds: send them through the `travel_rule/documents` endpoint of the withdrawal, which stays in `AWAITING_TRAVEL_RULE` meanwhile. Which ones is `travel_rule.required_documents`","example":false},"travel_rule":{"description":"The declaration as persisted, the same shape the withdrawal reads return, with `recipient.tax_id_number` masked","allOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleDeclaration"}]}},"required":["sn","state","documents_required","travel_rule"]},"WithdrawalTravelRuleOperationReason":{"type":"object","properties":{"code":{"type":"string","description":"BACEN operation reason code: the `operation_reason` of a withdrawal or deposit Travel Rule declaration","example":"32999"},"description":{"type":"string","description":"Human-readable, localized description of the operation reason","example":"International travel"},"requires_documents":{"type":"boolean","description":"Choosing this reason asks the client for documents before the withdrawal proceeds, sent through the `travel_rule/documents` endpoint of the withdrawal","example":false},"required_documents":{"description":"The documents this reason asks for, empty when it asks for none. After the declaration, the declaration of the operation lists the ones still pending in its `required_documents`","type":"array","items":{"$ref":"#/components/schemas/RequiredDocument"}}},"required":["code","description","requires_documents","required_documents"]},"WithdrawalTravelRuleOperationReasons":{"type":"object","properties":{"data":{"description":"The operation reasons (purposes) the Travel Rule declaration of this withdrawal accepts","type":"array","items":{"$ref":"#/components/schemas/WithdrawalTravelRuleOperationReason"}}},"required":["data"]},"WithdrawalTravelRuleDocumentsSubmitted":{"type":"object","properties":{"sn":{"type":"string","description":"The alphanumeric unique identifier of the withdrawal","example":"WDRZN4HKGT8MBP"},"state":{"type":"string","description":"Withdrawal state after the documents were attached. `AWAITING_TRAVEL_RULE_REVIEW` when the withdrawal is under review, `PROCESSING` when the withdrawal was released","enum":["SUBMITTING","SUBMITTED","AWAITING_TRAVEL_RULE","AWAITING_TRAVEL_RULE_REVIEW","PROCESSING","CANCELED","REJECTED","FAILED","DONE"],"example":"AWAITING_TRAVEL_RULE_REVIEW"},"case_state":{"type":"string","description":"State of the document request after the submission","example":"UNDER_REVIEW"}},"required":["sn","state","case_state"]},"Bank":{"type":"object","properties":{"abbreviation":{"type":"string","description":"Abbreviated name of the bank","example":"bb"},"name":{"type":"string","description":"Full name of the bank","example":"BANCO DO BRASIL"},"code":{"type":"number","description":"Code of the bank","example":1}}},"Banks":{"type":"object","properties":{"data":{"description":"The list of banks","type":"array","items":{"$ref":"#/components/schemas/Bank"}}}},"TransactionalLimit":{"type":"object","properties":{"deposit":{"type":"string","example":"150000","description":"Deposit limit"},"withdraw":{"type":"string","example":"300000","description":"Withdrawal limit"}},"required":["deposit","withdraw"]},"TransactionalLimits":{"type":"object","properties":{"currency_code":{"type":"string","example":"brl","description":"Currency code"},"total":{"description":"Limits total","allOf":[{"$ref":"#/components/schemas/TransactionalLimit"}]},"avaliable":{"description":"Limits available","allOf":[{"$ref":"#/components/schemas/TransactionalLimit"}]}},"required":["currency_code","total","avaliable"]},"TransactionalLimitsResponse":{"type":"object","properties":{"data":{"description":"Member transactional limits","type":"array","items":{"$ref":"#/components/schemas/TransactionalLimits"}}}},"MarketsBaseCurrencyModel":{"type":"object","properties":{"precision":{"type":"number","description":"Decimal places precision of currency","example":8},"name":{"type":"string","description":"Currency name","example":"Bitcoin"},"symbol":{"type":"string","description":"Currency symbol","example":"btc"}},"required":["precision","name","symbol"]},"MarketsQuoteCurrencyModel":{"type":"object","properties":{"precision":{"type":"number","description":"Decimal places precision of currency","example":2},"name":{"type":"string","description":"Currency name","example":"Real"},"symbol":{"type":"string","description":"Currency symbol","example":"brl"}},"required":["precision","name","symbol"]},"MarketModel":{"type":"object","properties":{"symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"name":{"type":"string","description":"Market name","example":"BTC/BRL"},"min_volume":{"type":"string","description":"Min volume of the market","example":"0.001"},"max_volume":{"type":"string","description":"Max volume of the market, or null when the market has no maximum","nullable":true,"example":"100"},"base":{"description":"Market base currency","allOf":[{"$ref":"#/components/schemas/MarketsBaseCurrencyModel"}]},"quote":{"description":"Market quote currency","allOf":[{"$ref":"#/components/schemas/MarketsQuoteCurrencyModel"}]}},"required":["symbol","name","min_volume","max_volume","base","quote"]},"MarketsResponseModel":{"type":"object","properties":{"data":{"description":"List of Prime Desk markets","type":"array","items":{"$ref":"#/components/schemas/MarketModel"}}},"required":["data"]},"RequestForQuoteByQuantity":{"type":"object","properties":{"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"side":{"type":"string","description":"The side of the operation that you will place the order","example":"BUY","enum":["BUY","SELL"]},"quantity":{"type":"string","description":"The quantity of the base currency you want to trade, expressed in string format","example":"0.42"}},"required":["market_symbol","side","quantity"]},"RequestForQuoteByAmount":{"type":"object","properties":{"market_symbol":{"type":"string","description":"The market symbol of the order to be created","example":"btcbrl"},"side":{"type":"string","description":"The side of the operation that you will place the order","example":"BUY","enum":["BUY","SELL"]},"amount":{"type":"string","description":"The amount of the quote currency you want to trade, expressed in string format","example":"500"}},"required":["market_symbol","side","amount"]},"RequestForQuoteResponseModel":{"type":"object","properties":{"quote_id":{"type":"string","description":"Unique identifier of the quote","example":"0856c960-4aa7-401a-b309-23ebd0236191"},"market_symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"side":{"type":"string","description":"Side of the operation","example":"BUY","enum":["BUY","SELL"]},"quantity":{"type":"string","description":"Quantity of the base currency","example":"0.42"},"price":{"type":"string","description":"Unit price of the quote, expressed in the quote currency","example":"178195.13"},"valid_until":{"type":"string","description":"Timestamp until which the quote is valid, in ISO-8601 UTC","example":"2021-11-25T13:23:27.961Z"}},"required":["quote_id","market_symbol","side","quantity","price","valid_until"]},"ExecuteQuoteCreatedModel":{"type":"object","properties":{"quote_id":{"type":"string","description":"Quote previously generated UUID","example":"27d92819-7f8b-4da2-b6cf-8e5e3a7c6de5"},"client_order_id":{"type":"string","description":"Client self-managed order UUID","nullable":true,"example":"4babec3d-6a59-4775-841c-159f60c8a058"},"market_symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"price":{"type":"string","description":"Order price","example":"350120.32"},"quantity":{"type":"string","description":"Order quantity","example":"0.001"},"side":{"type":"string","description":"Order side","enum":["BUY","SELL"],"example":"BUY"},"status":{"type":"string","description":"Order status. Always CREATED at this point — follow the execution progress through the\n      <a href=\"#tag/Prime-Desk/operation/list-prime-desk-executions\">executions history</a> endpoint","example":"CREATED"},"created":{"type":"string","description":"Order creation date in ISO-8601 UTC","example":"2020-12-16T19:47:27.000Z"}},"required":["quote_id","market_symbol","price","quantity","side","status","created"]},"PrimeDeskExecuteQuoteModel":{"type":"object","properties":{"client_order_id":{"type":"string","description":"Client self managed order UUID","example":"4babec3d-6a59-4775-841c-159f60c8a058"},"quote_id":{"type":"string","description":"Generated quote UUID","example":"27d92819-7f8b-4da2-b6cf-8e5e3a7c6de5"}},"required":["quote_id"]},"PrimeDeskExecutionHistoryData":{"type":"object","properties":{"quote_id":{"type":"string","description":"Generated Quote UUID","example":"b5f1b6b0-0e4c-4d0e-8b1d-3e0e2a0c3b9a"},"client_order_id":{"type":"string","nullable":true,"description":"Client self-managed order UUID","example":"0f80c9e2-1a5f-4f6b-9d3e-6a3a4e2c8f10"},"price":{"type":"string","description":"Price of base currency when quote was executed","example":"12500.32"},"market_symbol":{"type":"string","description":"Market symbol","example":"btcbrl"},"quantity":{"type":"string","description":"Executed quantity","example":"0.01"},"side":{"type":"string","enum":["BUY","SELL"],"description":"Side","example":"BUY"},"status":{"type":"string","enum":["CREATED","PENDING","AWAITING_PAYMENT","FILLED","ERROR","CANCELED"],"description":"Executed quote status\n    <table>\n      <thead>\n        <tr>\n          <th>Status</th>\n          <th>Description</th>\n        </tr>\n      </thead>\n      <tbody>\n        <tr>\n          <td>CREATED</td>\n          <td>The execution was created and is waiting to be processed</td>\n        </tr>\n        <tr>\n          <td>PENDING</td>\n          <td>The execution is being processed</td>\n        </tr>\n        <tr>\n          <td>AWAITING_PAYMENT</td>\n          <td>The trade was executed and waits to be paid; it becomes FILLED once paid</td>\n        </tr>\n        <tr>\n          <td>FILLED</td>\n          <td>The execution was completed successfully</td>\n        </tr>\n        <tr>\n          <td>ERROR</td>\n          <td>The execution failed — see error_message</td>\n        </tr>\n        <tr>\n          <td>CANCELED</td>\n          <td>The execution was canceled</td>\n        </tr>\n      </tbody>\n    </table>","example":"FILLED"},"created_at":{"type":"string","description":"The creation date of this execution in ISO-8601 UTC","example":"2020-12-09T14:56:55.000Z"},"error_message":{"type":"string","description":"Error message, present when the execution failed","example":"Unexpected error while processing the order"}},"required":["quote_id","client_order_id","price","market_symbol","quantity","side","status","created_at"]},"PrimeDeskExecutionHistoryModel":{"type":"object","properties":{"total":{"type":"number","description":"Total number of records","example":12},"data":{"description":"Execution history data","example":[{"quote_id":"b5f1b6b0-0e4c-4d0e-8b1d-3e0e2a0c3b9a","client_order_id":"0f80c9e2-1a5f-4f6b-9d3e-6a3a4e2c8f10","price":"350120.32","market_symbol":"btcbrl","quantity":"0.01","side":"BUY","status":"FILLED","created_at":"2020-12-09T14:56:55.000Z"},{"quote_id":"2bf2a42e-dfac-4c7f-b734-6ec057ccd7ce","client_order_id":null,"price":"349870.10","market_symbol":"btcbrl","quantity":"0.05","side":"SELL","status":"ERROR","created_at":"2020-12-09T14:50:12.000Z","error_message":"Unexpected error while processing the order"}],"type":"array","items":{"$ref":"#/components/schemas/PrimeDeskExecutionHistoryData"}}},"required":["total","data"]},"Country":{"type":"object","properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 code, the value accepted by the Travel Rule country questions","example":"BR"},"name":{"type":"string","description":"Country name localized by the Locale header","example":"Brazil"}},"required":["code","name"]},"Countries":{"type":"object","properties":{"data":{"description":"The list of countries accepted in the Travel Rule declaration, ordered by name","type":"array","items":{"$ref":"#/components/schemas/Country"}}},"required":["data"]},"DepositTravelRuleDeclarationRequest":{"oneOf":[{"$ref":"#/components/schemas/DepositTravelRuleOwnPrivateWallet"},{"$ref":"#/components/schemas/DepositTravelRuleOwnExchangeWallet"},{"$ref":"#/components/schemas/DepositTravelRuleThirdPartyPrivateWallet"},{"$ref":"#/components/schemas/DepositTravelRuleThirdPartyExchangeWallet"}]},"Candlestick":{"type":"array","items":{"$ref":"#/components/schemas/CandlestickInner"},"minItems":11,"maxItems":11},"CreateOrderRequest":{"oneOf":[{"$ref":"#/components/schemas/OrderLimit"},{"$ref":"#/components/schemas/OrderMarket"},{"$ref":"#/components/schemas/OrderInstant"},{"$ref":"#/components/schemas/OrderStopLimit"},{"allOf":[{"$ref":"#/components/schemas/OrderStop"}],"title":"OrderStopMarket"},{"$ref":"#/components/schemas/OrderTrailingStopLimit"},{"allOf":[{"$ref":"#/components/schemas/OrderTrailingStopMarket"}],"title":"OrderTrailingStopMarket"},{"$ref":"#/components/schemas/OrderOco"}]},"CancelOrdersRequest":{"oneOf":[{"$ref":"#/components/schemas/OrdersCancelAll"},{"$ref":"#/components/schemas/OrdersCancelSn"},{"$ref":"#/components/schemas/OrdersCancelId"},{"$ref":"#/components/schemas/OrdersCancelClientOrderId"},{"$ref":"#/components/schemas/OrdersCancelMarket"},{"$ref":"#/components/schemas/OrdersCancelMarketSide"}]},"RequestForQuote":{"oneOf":[{"$ref":"#/components/schemas/RequestForQuoteByQuantity"},{"$ref":"#/components/schemas/RequestForQuoteByAmount"}]},"CreateWithdrawalRequest":{"oneOf":[{"$ref":"#/components/schemas/WithdrawalFiat"},{"$ref":"#/components/schemas/WithdrawalCrypto"}]},"WithdrawalTravelRuleDeclarationRequest":{"oneOf":[{"$ref":"#/components/schemas/WithdrawalTravelRuleOwnPrivateWallet"},{"$ref":"#/components/schemas/WithdrawalTravelRuleOwnExchangeWallet"},{"$ref":"#/components/schemas/WithdrawalTravelRuleThirdPartyPrivateWallet"},{"$ref":"#/components/schemas/WithdrawalTravelRuleThirdPartyExchangeWallet"}]},"CandlestickInner":{"oneOf":[{"type":"string"},{"type":"number"}]}}},"x-tagGroups":[{"name":"Public Endpoints","tags":["Market Data","Banks","System","Travel Rule"]},{"name":"Authenticated Endpoints","tags":["Member Info","Trading","Account","Deposit","Withdrawal","Transactional Limits","Automation","Prime Desk"]}]}