{"version":1,"pages":[{"id":"-MjZyNgvZ8BvLAZYS_j_","title":"Welcome","pathname":"/","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"phcm6CBdpfTOGCztXRMV","title":"Getting Started","pathname":"/introduction/getting-started","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"Introduction"}]},{"id":"dCQ0XfYBvq6CHzWy2TjF","title":"Systems & Operations","pathname":"/introduction/systems-and-operations","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"Introduction"}]},{"id":"aKLA3GOl9uGOMLbnMzTg","title":"Rate Limits","pathname":"/introduction/rate-limits","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"ocFhkxzIGI6gutUfzy4v","title":"REST Endpoints","pathname":"/rest-api/rest-endpoints","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"G3R1xNlOWSjDGrCbywMc","title":"Authentication","pathname":"/rest-api/authentication","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"dTQ3EbRb9v0m2z3BToAl","title":"Rate Limits","pathname":"/rest-api/rate-limits","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"-Mj_5-P-yMJl0Lk4ft-W","title":"Account Management","pathname":"/rest-api/account-management","siteSpaceId":"sitesp_KXRZG","description":"Account information including current balances, transactions, currencies, pairs, and fee rates.","breadcrumbs":[{"label":"REST API"}]},{"id":"Ae9pdGWteXDiRClMeGgC","title":"Get All Balances","pathname":"/rest-api/account-management/get-all-balances","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Account Management"}]},{"id":"Grti2aqUE89NUXctXbQE","title":"Get All Currencies","pathname":"/rest-api/account-management/get-all-currencies","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Account Management"}]},{"id":"hOsRYjg1v83uC3VxeiXR","title":"Get All Currency Pairs","pathname":"/rest-api/account-management/get-all-currency-pairs","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Account Management"}]},{"id":"3t0VkDg7kMMTuLHoV2eI","title":"Get All Transactions","pathname":"/rest-api/account-management/get-all-transactions","siteSpaceId":"sitesp_KXRZG","description":"Retrieve your transaction history","breadcrumbs":[{"label":"REST API"},{"label":"Account Management"}]},{"id":"6WcC4Zg484vIvmPQgwAF","title":"Get Fees","pathname":"/rest-api/account-management/get-fees","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Account Management"}]},{"id":"-Mkd5fv0VwgWbHGXHO7z","title":"Orders","pathname":"/rest-api/orders","siteSpaceId":"sitesp_KXRZG","description":"Create, cancel, amend, and manage orders","breadcrumbs":[{"label":"REST API"}]},{"id":"-MksB3OWKUp0-RnwDoxN","title":"Order Types","pathname":"/rest-api/orders/algorithms-and-routing-types","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"0pYHApvaV1uMz75F9PA3","title":"Create Order","pathname":"/rest-api/orders/create-order","siteSpaceId":"sitesp_KXRZG","description":"Create an order","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"Y9UWl1weMDXCJ2bKyZsH","title":"Cancel Order","pathname":"/rest-api/orders/cancel-order","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"l1RssepYoTTbTSYZNTmX","title":"Cancel Multiple Orders","pathname":"/rest-api/orders/cancel-multiple-orders","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"YBeW13lAEiS36QTwUClH","title":"Cancel All Orders","pathname":"/rest-api/orders/cancel-all-orders","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"3jPkZPuTflGRWNsINl3v","title":"Amend Order","pathname":"/rest-api/orders/amend-order","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"PCvjaxxBO6mF5wx8veAQ","title":"Get Single Order","pathname":"/rest-api/orders/get-single-order","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"Vf6lZxVvaTIPLLiXV3SD","title":"Get All Open Orders","pathname":"/rest-api/orders/get-all-open-orders","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"8XOlhypPneS1KBMTLwvS","title":"Get All Done Orders","pathname":"/rest-api/orders/get-all-done-orders","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"UwV8tbQ9PsoH4cJmZS7o","title":"Get All Trades","pathname":"/rest-api/orders/get-all-trades","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Orders"}]},{"id":"nEOyHVWWrh7jJmuSU6Sx","title":"Request for Quote (RFQ)","pathname":"/rest-api/request-for-quote-rfq","siteSpaceId":"sitesp_KXRZG","description":"Send Requests for Quotes","breadcrumbs":[{"label":"REST API"}]},{"id":"q1lWYKccyZwe6ad7aBIo","title":"Post-Trade Settlement (PTS)","pathname":"/rest-api/post-trade-settlement-pts","siteSpaceId":"sitesp_KXRZG","description":"Manage positions, settlement, and risk","breadcrumbs":[{"label":"REST API"}]},{"id":"SwkwcdU1WI0kWGJZtVJ4","title":"Get Account Risk Metrics","pathname":"/rest-api/post-trade-settlement-pts/get-account-risk-metrics","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"PziYm6yM5rtQKv0iFLC5","title":"Get All Positions","pathname":"/rest-api/post-trade-settlement-pts/get-all-positions","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"7X9kvhXhPqoVQ0Z1vc7M","title":"Get All Funding Transactions","pathname":"/rest-api/post-trade-settlement-pts/get-all-funding-transactions","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"BLHZu7Q5OswD9WsVSZJ1","title":"Get All Funding Rates","pathname":"/rest-api/post-trade-settlement-pts/get-all-funding-rates","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"hH0pTUjbmNbWGnaiEFmj","title":"Get All Risk Modes","pathname":"/rest-api/post-trade-settlement-pts/get-all-risk-modes","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"O1S6iCfEYyDexIJw8g42","title":"Create Transfer","pathname":"/rest-api/post-trade-settlement-pts/create-transfer","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Post-Trade Settlement (PTS)"}]},{"id":"Fhr89qTxGfsewAvKjz3o","title":"Shorting","pathname":"/rest-api/shorting","siteSpaceId":"sitesp_KXRZG","description":"Manage short positions, position settlement, and portfolio risk","breadcrumbs":[{"label":"REST API"}]},{"id":"r5KCWA1WVASLLaOwyF0U","title":"Get Account Risk Metrics","pathname":"/rest-api/shorting/get-account-risk-metrics","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Shorting"}]},{"id":"DcBOD34luRXsIRlEP9p2","title":"Get All Positions","pathname":"/rest-api/shorting/get-all-positions","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Shorting"}]},{"id":"sM2k4HGaomsDmqpM0CnO","title":"Transfers","pathname":"/rest-api/transfers","siteSpaceId":"sitesp_KXRZG","description":"Deposit to, withdraw from, and transfer within your sFOX account","breadcrumbs":[{"label":"REST API"}]},{"id":"kdLLLHwtvOMR8tcLOujW","title":"Get All Deposit Addresses","pathname":"/rest-api/transfers/get-all-deposit-addresses","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"A0nz3XBnEm4mrd4DJj7M","title":"Get Single Deposit Address","pathname":"/rest-api/transfers/get-single-deposit-address","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"jO5HdwV63TYz5RU8u9ie","title":"Create Deposit Address","pathname":"/rest-api/transfers/create-deposit-address","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"HM4jiFy24W7P1DAVX9hq","title":"Deposit From Bank Account","pathname":"/rest-api/transfers/deposit-from-bank-account","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"jcFewO4Y93hsgmzGPRAJ","title":"Withdraw From Account","pathname":"/rest-api/transfers/withdraw-from-account","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"FQdCd71LILlXTo5LmnXT","title":"Get Single Withdrawal Fee","pathname":"/rest-api/transfers/get-single-withdrawal-fee","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"Uv3kTx5DeT9JbKym0Dl5","title":"Create Transfer","pathname":"/rest-api/transfers/create-transfer","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"-MjdzCmc-D-yGdFkgN0T","title":"Custody (sFOX SAFE)","pathname":"/rest-api/custody","siteSpaceId":"sitesp_KXRZG","description":"sFOX SAFE Custody is available all sFOX users. However, access is not granted by default. Contact support to request access.","breadcrumbs":[{"label":"REST API"}]},{"id":"4vtypvfCUNVCV9MGXbC4","title":"Get Whitelisted Addresses","pathname":"/rest-api/custody/get-whitelisted-addresses","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"JuVkhfAvtq4rIi0pHdq7","title":"Add Whitelisted Address","pathname":"/rest-api/custody/add-whitelisted-address","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"deVcE6PGyG7Ua22yuVxK","title":"Delete Whitelisted Address","pathname":"/rest-api/custody/delete-whitelisted-address","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"lIqdgX8A51Y77OVquJgg","title":"Get Approval Rules","pathname":"/rest-api/custody/get-approval-rules","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"bX8SbXdhvs6AV311HPNR","title":"Create Approval Rule","pathname":"/rest-api/custody/create-approval-rule","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"F5RO0Qok7tgfHGNh8FLT","title":"Edit Approval Rule","pathname":"/rest-api/custody/edit-approval-rule","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"FP4sHmBhXf5tC5TRP7AX","title":"Get Approval Requests","pathname":"/rest-api/custody/get-approval-requests","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"m1m4I4JuF13hFbgj1i5Y","title":"Respond to Approval Request","pathname":"/rest-api/custody/respond-to-approval-request","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Custody (sFOX SAFE)"}]},{"id":"BtqsSLr0UkCffVk9knHC","title":"Staking","pathname":"/rest-api/staking","siteSpaceId":"sitesp_KXRZG","description":"Earn rewards on your holdings by staking supported digital assets. Once you have completed account verification, staking will be enabled for your account. Only certain assets are available to stake.","breadcrumbs":[{"label":"REST API"}]},{"id":"S1WEuaBoZ5rLCzMMypZ5","title":"Get Staking Currencies","pathname":"/rest-api/staking/get-staking-currencies","siteSpaceId":"sitesp_KXRZG","breadcrumbs":[{"label":"REST API"},{"label":"Staking"}]},{"id":"zh7g3Qss6lKqLufL4O3K","title":"Get All Staking Transactions","pathname":"/rest-api/staking/get-all-staking-transactions","siteSpaceId":"sitesp_KXRZG","description":"Staking and reward transaction history","breadcrumbs":[{"label":"REST API"},{"label":"Staking"}]},{"id":"5MbGyXnCVIQsr75opFyM","title":"Create Stake","pathname":"/rest-api/staking/create-stake","siteSpaceId":"sitesp_KXRZG","description":"Submit a request to stake an asset","breadcrumbs":[{"label":"REST API"},{"label":"Staking"}]},{"id":"xXo78jwpejWHvoIQiN9K","title":"Cancel Stake","pathname":"/rest-api/staking/cancel-stake","siteSpaceId":"sitesp_KXRZG","description":"Submit a request to stake an asset","breadcrumbs":[{"label":"REST API"},{"label":"Staking"}]},{"id":"g43xDZ9D0s9pXPmYDu0g","title":"Unstake","pathname":"/rest-api/staking/unstake","siteSpaceId":"sitesp_KXRZG","description":"Submit a request to unstake an asset","breadcrumbs":[{"label":"REST API"},{"label":"Staking"}]},{"id":"-MksChead2Prx4OAHdXV","title":"Market Data","pathname":"/rest-api/market-data","siteSpaceId":"sitesp_KXRZG","description":"Retrieve market data from sFOX","breadcrumbs":[{"label":"REST API"}]},{"id":"HoUS6l45i8X7tYKJBIbb","title":"Get Candlesticks","pathname":"/rest-api/market-data/get-candlesticks","siteSpaceId":"sitesp_KXRZG","description":"Historical candlestick data for a currency pair","breadcrumbs":[{"label":"REST API"},{"label":"Market Data"}]},{"id":"D6vVmF5scUerC2HxTTDz","title":"Get Volume Analytics","pathname":"/rest-api/market-data/get-volume-analytics","siteSpaceId":"sitesp_KXRZG","description":"Historical volume data by currency","breadcrumbs":[{"label":"REST API"},{"label":"Market Data"}]},{"id":"Gq6D9m1VngRjmOG7Hllm","title":"Get Order Estimate","pathname":"/rest-api/market-data/get-order-estimate","siteSpaceId":"sitesp_KXRZG","description":"Smart Routing Order Estimate","breadcrumbs":[{"label":"REST API"},{"label":"Market Data"}]},{"id":"XMkFODI8dLeWAgs780Sd","title":"Get Order Book","pathname":"/rest-api/market-data/get-order-book","siteSpaceId":"sitesp_KXRZG","description":"Order book snapshot for a currency pair.","breadcrumbs":[{"label":"REST API"},{"label":"Market Data"}]},{"id":"4tZjyhK3tG8gRjC2bzbd","title":"Reporting","pathname":"/rest-api/reporting","siteSpaceId":"sitesp_KXRZG","description":"Account transaction history and tax aid reports","breadcrumbs":[{"label":"REST API"}]},{"id":"h1q1JmGP5q1mxgilihgC","title":"Get Orders Report","pathname":"/rest-api/reporting/get-orders-report","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Reporting"}]},{"id":"eoiwhb1a83GUc04nVmBI","title":"Get Monthly Summary","pathname":"/rest-api/reporting/get-monthly-summary","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Reporting"}]},{"id":"8P6wWonKkvnEoBNhuyzA","title":"Get Portfolio Valuation","pathname":"/rest-api/reporting/get-portfolio-valuation","siteSpaceId":"sitesp_KXRZG","description":"USD valuation of your portfolio over time","breadcrumbs":[{"label":"REST API"},{"label":"Reporting"}]},{"id":"LgDHTm1ifQQhbsRgApnJ","title":"Get All Transactions","pathname":"/rest-api/reporting/get-all-transactions","siteSpaceId":"sitesp_KXRZG","description":"Retrieve your transaction history","breadcrumbs":[{"label":"REST API"},{"label":"Reporting"}]},{"id":"CqT1WI6h3lfa4qqxlygs","title":"Introduction","pathname":"/websocket-api/introduction","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"cbXxSmQ4ogUCY8yXCTDu","title":"Connecting","pathname":"/websocket-api/connecting","siteSpaceId":"sitesp_KXRZG","description":"Connecting to the WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"VRq60PTEio3LqiH1vhRj","title":"Rate Limits","pathname":"/websocket-api/rate-limits","siteSpaceId":"sitesp_KXRZG","description":"Connecting to the WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"y9HwaWgu7Ijs2Z4QVxCH","title":"Authentication","pathname":"/websocket-api/authentication","siteSpaceId":"sitesp_KXRZG","description":"Authenticating to the WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"G3uzmcqW7dLacaNdNaYn","title":"Subscribing & Unsubscribing","pathname":"/websocket-api/subscribing-and-unsubscribing","siteSpaceId":"sitesp_KXRZG","description":"Subscribing or unsubscribing to WebSocket feeds","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"ZHy5osffRKJIpzV2tSvv","title":"Message Format","pathname":"/websocket-api/message-format","siteSpaceId":"sitesp_KXRZG","description":"WebSocket API message format","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"O6rHXMWk2uDWFXpo9d1E","title":"Market Data","pathname":"/websocket-api/market-data","siteSpaceId":"sitesp_KXRZG","description":"Receive real-time streaming market data from the sFOX WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"4CQgv3BxIh9W9BbKsZnF","title":"Order Book","pathname":"/websocket-api/market-data/order-book","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming order book data","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"OXAMdIJf07DyIT68P8IM","title":"Trades","pathname":"/websocket-api/market-data/trades","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming tick data of publicly executed trades","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"NbNxoPL3jnDf6CiEawnl","title":"Ticker","pathname":"/websocket-api/market-data/ticker","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming day OHLCV data and last trade","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"HdQ5W6qVYMi4Ubjmowp0","title":"Orders & Account Data","pathname":"/websocket-api/orders-and-account-data","siteSpaceId":"sitesp_KXRZG","description":"Receive real-time streaming account updates from the sFOX WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"mLvBQA85lIokfQOiTdS1","title":"Orders","pathname":"/websocket-api/orders-and-account-data/orders","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming updates to your open orders","breadcrumbs":[{"label":"WebSocket API"},{"label":"Orders & Account Data"}]},{"id":"aOHfJ9hRv1zQLo4ouy2e","title":"Trades","pathname":"/websocket-api/orders-and-account-data/trades","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming updates of completed trades.","breadcrumbs":[{"label":"WebSocket API"},{"label":"Orders & Account Data"}]},{"id":"iVOSvuFhBr5DdDK7xGHv","title":"Balances","pathname":"/websocket-api/orders-and-account-data/balances","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming updates to your account balances","breadcrumbs":[{"label":"WebSocket API"},{"label":"Orders & Account Data"}]},{"id":"nzNxYDBDoFJOIRB2vs4p","title":"Post-Trade Settlement","pathname":"/websocket-api/orders-and-account-data/post-trade-settlement","siteSpaceId":"sitesp_KXRZG","description":"Real-time streaming account post-trade settlement credit and risk updates","breadcrumbs":[{"label":"WebSocket API"},{"label":"Orders & Account Data"}]},{"id":"-MlBygd-VLX2UE-s1-8n","title":"FIX Order Entry","pathname":"/fix-api/fix","siteSpaceId":"sitesp_KXRZG","description":"Use the FIX Order Entry session to submit, manage, and cancel orders.","breadcrumbs":[{"label":"FIX API"}]},{"id":"N9T5Alu2UbeosPaPDN9L","title":"FIX Market Data","pathname":"/fix-api/fix-market-data","siteSpaceId":"sitesp_KXRZG","description":"Use the FIX Market Data session to receive market data from the FIX API","breadcrumbs":[{"label":"FIX API"}]},{"id":"HuaKJ6aKQCWIXfH03nUS","title":"QuickFIX Guide","pathname":"/fix-api/quickfix-guide","siteSpaceId":"sitesp_KXRZG","description":"How to start integrating sFOX's FIX API using the QuickFIX FIX Engine Library","breadcrumbs":[{"label":"FIX API"}]},{"id":"-MlByG-hjtzrUffSO1xB","title":"Error Codes","pathname":"/errors/error-codes","siteSpaceId":"sitesp_KXRZG","description":"","breadcrumbs":[{"label":"Errors"}]},{"id":"-MjZyNgvZ8BvLAZYS_j_","title":"Welcome","pathname":"/connect","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"kDaXxevxTK122Ojsdoze","title":"Getting Started","pathname":"/connect/introduction/getting-started","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"Introduction"}]},{"id":"u9K4pNLumPEi0tNfmNsL","title":"Resources","pathname":"/connect/introduction/resources","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"}]},{"id":"kFghWvotNjiYYA3nNIIS","title":"Terminology","pathname":"/connect/introduction/resources/terminology","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Resources"}]},{"id":"9BI4XQ0CnDifESBEyK4g","title":"Systems & Operations","pathname":"/connect/introduction/resources/systems-and-operations","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Resources"}]},{"id":"2lADS3NSTlfSoDHM2ZKZ","title":"Integration Options","pathname":"/connect/introduction/resources/integration-options","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Resources"}]},{"id":"9GolVwSPdp41OqT9w3VC","title":"Guides","pathname":"/connect/introduction/guides","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"}]},{"id":"ntmQkipq79LmuJQMBqVb","title":"End User Onboarding & KYC","pathname":"/connect/introduction/guides/onboarding","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Guides"}]},{"id":"PHnKCC8rB34WWYDnm2bK","title":"Quick Start: Individual Accounts","pathname":"/connect/introduction/guides/onboarding/quick-start-individual-accounts","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Guides"},{"label":"End User Onboarding & KYC"}]},{"id":"rM48Z8edg8kULpdfpze3","title":"Individuals","pathname":"/connect/introduction/guides/onboarding/individuals","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Guides"},{"label":"End User Onboarding & KYC"}]},{"id":"9YeXrmJBbA5CFsbYiyov","title":"Businesses","pathname":"/connect/introduction/guides/onboarding/businesses","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"Introduction"},{"label":"Guides"},{"label":"End User Onboarding & KYC"}]},{"id":"Ly8mxalaLgavh6Tflzw4","title":"Enhanced Due Diligence (EDD)","pathname":"/connect/introduction/guides/onboarding/enhanced-due-diligence-edd","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"Introduction"},{"label":"Guides"},{"label":"End User Onboarding & KYC"}]},{"id":"ocFhkxzIGI6gutUfzy4v","title":"REST Endpoints","pathname":"/connect/rest-api/rest-endpoints","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"G3R1xNlOWSjDGrCbywMc","title":"Authentication","pathname":"/connect/rest-api/authentication","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"rS7Gs0m80M408vWgAU1k","title":"End Users","pathname":"/connect/rest-api/end-users","siteSpaceId":"sitesp_RHmzi","description":"User management","breadcrumbs":[{"label":"REST API"}]},{"id":"wkNmtRoP8TnEPRcONW4u","title":"Create End User","pathname":"/connect/rest-api/end-users/create-end-user","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"VKxkLnWWUfvGGGt9QfjR","title":"Update End User","pathname":"/connect/rest-api/end-users/update-end-user","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"3TWxDYrvwqgDa66tRlH4","title":"Get End User","pathname":"/connect/rest-api/end-users/get-end-user","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"yS5NDnPEfrGck4zzlhiU","title":"Get Multiple End Users","pathname":"/connect/rest-api/end-users/get-multiple-end-users","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"pvG3mhR2VqXXIEf0tk2H","title":"Create User Auth Token","pathname":"/connect/rest-api/end-users/create-user-auth-token","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"Gik7PV0UO6rHEPHthZeK","title":"Create Multiple User Auth Tokens","pathname":"/connect/rest-api/end-users/create-multiple-user-auth-tokens","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"XNT45pXgriVUgj6rlFv5","title":"Create Verification Code","pathname":"/connect/rest-api/end-users/create-verification-code","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"ikk27VB9fUmTgYG5FV3L","title":"Confirm Verification Code","pathname":"/connect/rest-api/end-users/confirm-verification-code","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"d4rUFy0wiXdhN76bF0DU","title":"Get EDD Requests","pathname":"/connect/rest-api/end-users/get-edd-requests","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"o4v5Sk7fNaut4L4fQl2p","title":"Get EDD Prompts","pathname":"/connect/rest-api/end-users/get-edd-prompts","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"rUMtIPR4W65O6vY8TJab","title":"Create EDD Responses","pathname":"/connect/rest-api/end-users/create-edd-responses","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"hlVniGanqnAfVBdjRmnA","title":"Submit Documents","pathname":"/connect/rest-api/end-users/submit-documents","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"JxRrnQGKWnEW5XV8SNpf","title":"Submit Documents API","pathname":"/connect/rest-api/end-users/submit-documents/submit-documents-api","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"},{"label":"Submit Documents"}]},{"id":"kjL8mSmd6Sbyo9DAGyUx","title":"Submit Documents API (Legacy)","pathname":"/connect/rest-api/end-users/submit-documents/submit-documents-api-legacy","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"},{"label":"Submit Documents"}]},{"id":"eEkbpgWxjPliMWx6W733","title":"Submit Documents (SFTP)","pathname":"/connect/rest-api/end-users/submit-documents/submit-documents-sftp","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"End Users"},{"label":"Submit Documents"}]},{"id":"z2FGzBV877C7droKUTqp","title":"Deactivate User","pathname":"/connect/rest-api/end-users/deactivate-user","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"End Users"}]},{"id":"EmDMjBbTSy1NxFgqGtr3","title":"Payments","pathname":"/connect/rest-api/payments","siteSpaceId":"sitesp_RHmzi","description":"Link a bank account and get wire instructions","breadcrumbs":[{"label":"REST API"}]},{"id":"gzqSghpKFdTw4CfFMXGw","title":"Get Bank Account","pathname":"/connect/rest-api/payments/get-bank-account","siteSpaceId":"sitesp_RHmzi","description":"Returns the status and account information of the linked bank account","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"CWdciwOkOxILxUSOyQnC","title":"Create Bank Account (Plaid)","pathname":"/connect/rest-api/payments/create-bank-account-plaid","siteSpaceId":"sitesp_RHmzi","description":"Saves bank account information for your sFOX account","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"it3rqT5OWw7iEbaZ4BN3","title":"Create Bank Account","pathname":"/connect/rest-api/payments/create-bank-account","siteSpaceId":"sitesp_RHmzi","description":"Saves bank account information for your sFOX account","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"bq5iRmKSr6I1xALeI1Nz","title":"Delete Bank Account","pathname":"/connect/rest-api/payments/delete-bank-account","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"DOep9vkfsDrtZ868evdJ","title":"Verify Bank Account","pathname":"/connect/rest-api/payments/verify-bank-account","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"84vGNcaUDo88bLMJJQSc","title":"Get Wire Instructions","pathname":"/connect/rest-api/payments/account-management","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"p0XmepYv662zE0UGwpd3","title":"Get Plaid Processors","pathname":"/connect/rest-api/payments/get-plaid-processors","siteSpaceId":"sitesp_RHmzi","description":"Saves bank account information for your sFOX account","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"RpICGyrpv1GM44yvd2ww","title":"Amend Plaid Processors","pathname":"/connect/rest-api/payments/amend-plaid-processors","siteSpaceId":"sitesp_RHmzi","description":"Saves bank account information for your sFOX account","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"17ku063NIe4vnQ562aqw","title":"Get ACH Agreement Status","pathname":"/connect/rest-api/payments/get-ach-agreement-status","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"craN6KonayziHEpJR0es","title":"Request ACH Onboarding","pathname":"/connect/rest-api/payments/request-ach-onboarding","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"VAYNs9Qx5e5WJwBQ0JqD","title":"Get ACH Deposit Limit","pathname":"/connect/rest-api/payments/get-ach-deposit-limit","siteSpaceId":"sitesp_RHmzi","description":"sFOX has partnered up with Dwolla, a US payments processing platform, to integrate ACH Transfer capabilities.","breadcrumbs":[{"label":"REST API"},{"label":"Payments"}]},{"id":"95oGChFN8eJ9XkBhath4","title":"Withdrawals","pathname":"/connect/rest-api/withdrawals","siteSpaceId":"sitesp_RHmzi","description":"Withdrawal Management and Confirmation","breadcrumbs":[{"label":"REST API"}]},{"id":"nSQpWgLzcaNMDSpA8xxY","title":"Confirm Withdrawal","pathname":"/connect/rest-api/withdrawals/confirm-withdrawal","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Withdrawals"}]},{"id":"AEswToVqylvEu1xhuLXk","title":"Resend Confirmation Code","pathname":"/connect/rest-api/withdrawals/resend-confirmation-code","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Withdrawals"}]},{"id":"VV2cENX9m8G802BYO9R2","title":"Cancel Withdrawal","pathname":"/connect/rest-api/withdrawals/cancel-withdrawal","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Withdrawals"}]},{"id":"rfF4d63hEGrvJABun3jm","title":"Transfers","pathname":"/connect/rest-api/transfers","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"}]},{"id":"wTicxjMqMCU0HkGkdIbF","title":"Create Transfer","pathname":"/connect/rest-api/transfers/create-transfer","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"aI99kki91pI8f5DIGrgA","title":"Confirm Transfer","pathname":"/connect/rest-api/transfers/confirm-transfer","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"0ipvpSQbvtYDKwq9Cudn","title":"Resend Confirmation Code","pathname":"/connect/rest-api/transfers/resend-confirmation-code","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"2MDHMyUGgzRvY4jIVUeR","title":"Cancel Transfer","pathname":"/connect/rest-api/transfers/cancel-transfer","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"ereeiVAzs4MG2iFUGcyC","title":"Get Transfer Permissions","pathname":"/connect/rest-api/transfers/get-transfer-permissions","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"j4PvtQySPEiWnRTcK15a","title":"Get Transfer History","pathname":"/connect/rest-api/transfers/get-transfer-history","siteSpaceId":"sitesp_RHmzi","breadcrumbs":[{"label":"REST API"},{"label":"Transfers"}]},{"id":"YthKxyDrS9TtOMSflNJf","title":"Monetization","pathname":"/connect/rest-api/monetization","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"}]},{"id":"jem45RiGKKmNZovmaq9w","title":"Get Settings","pathname":"/connect/rest-api/monetization/get-settings","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"ZJetfdG4bT91Y2LVkQ3F","title":"Create Setting","pathname":"/connect/rest-api/monetization/create-setting","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"SHUOAwXoXCZvJuaki9HU","title":"Update Setting","pathname":"/connect/rest-api/monetization/update-setting","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"9xn2WrkfXrE7ERq9n04n","title":"Delete Setting","pathname":"/connect/rest-api/monetization/delete-setting","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"jCyUrd7GrFGRhMiAA6D6","title":"Get Permissions","pathname":"/connect/rest-api/monetization/get-permissions","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"qOFTZYULP2bIR1C0q3Eg","title":"Get Monetization History","pathname":"/connect/rest-api/monetization/get-monetization-history","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Monetization"}]},{"id":"zPGcJc5qNmahYFDY24Cp","title":"Connecting","pathname":"/connect/websocket-api/websocket-feeds","siteSpaceId":"sitesp_RHmzi","description":"Connecting to the sFOX Connect WebSocket feed gives you access to real-time updates about your users and market data","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"GeIjIUsSxqQ343TIbAh4","title":"Authentication","pathname":"/connect/websocket-api/websocket-feeds-1","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"lYfvGxyH7UE44uPraODo","title":"Subscribing & Unsubscribing","pathname":"/connect/websocket-api/websocket-feeds-2","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"KJY4LDFUPYyIp757EpYv","title":"Message Format","pathname":"/connect/websocket-api/websocket-feeds-3","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"OUTxKqgKcbcHLPQVIDes","title":"End Users","pathname":"/connect/websocket-api/end-users","siteSpaceId":"sitesp_RHmzi","description":"Stream account data from all of your end users","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"tXpRTCnMs1BtxJ6nKIBf","title":"Onboarding","pathname":"/connect/websocket-api/end-users/users","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"},{"label":"End Users"}]},{"id":"t8jzqrYpS0ASj7BK1DaW","title":"Balances","pathname":"/connect/websocket-api/end-users/users-1","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"},{"label":"End Users"}]},{"id":"NOosXBps7kW9hOY3838X","title":"Orders","pathname":"/connect/websocket-api/end-users/users-2","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"},{"label":"End Users"}]},{"id":"mEWR46yiGM0yDZAUG0n1","title":"Trades","pathname":"/connect/websocket-api/end-users/users-3","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"WebSocket API"},{"label":"End Users"}]},{"id":"sN7ImJYT6qW9gDLtFtQB","title":"Market Data","pathname":"/connect/websocket-api/market-data","siteSpaceId":"sitesp_RHmzi","description":"Receive real-time streaming market data from the sFOX WebSocket API","breadcrumbs":[{"label":"WebSocket API"}]},{"id":"4yRVYMcKlM4VyfYikcIs","title":"Order Book","pathname":"/connect/websocket-api/market-data/users","siteSpaceId":"sitesp_RHmzi","description":"Real-time order books for a specified currency pair.","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"giyTHoKKac7Nkt7gKzUr","title":"Trades","pathname":"/connect/websocket-api/market-data/users-1","siteSpaceId":"sitesp_RHmzi","description":"Real-time tick data feed of any trade executed on sFOX’s supported liquidity venues","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"RdwqT2ewJAAKPJtP9w91","title":"Ticker","pathname":"/connect/websocket-api/market-data/users-2","siteSpaceId":"sitesp_RHmzi","description":"Real-time streaming day OHLCV and last trade data","breadcrumbs":[{"label":"WebSocket API"},{"label":"Market Data"}]},{"id":"m2XMjnK2gRwuDfJAvyis","title":"Overview","pathname":"/connect/single-sign-on/overview","siteSpaceId":"sitesp_RHmzi","description":"SSO integrations enable partners to seamlessly authenticate users to sFOX and utilize sFOX's front end","breadcrumbs":[{"label":"Single Sign-On"}]},{"id":"ILGmgGs7ClYg6Zwgxct0","title":"IdP Initiated SSO","pathname":"/connect/single-sign-on/overview/idp-initiated-sso","siteSpaceId":"sitesp_RHmzi","description":"The following graphic and description provides an overview of the SSO integration","breadcrumbs":[{"label":"Single Sign-On"},{"label":"Overview"}]},{"id":"tOfep5erjCrniiPug5gB","title":"IdP Data","pathname":"/connect/single-sign-on/idp-data","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"Single Sign-On"}]},{"id":"0S6Zs899VWPMsbaXOrYr","title":"SAML Response Data","pathname":"/connect/single-sign-on/account-management","siteSpaceId":"sitesp_RHmzi","description":"Your enterprise would send the following SAML Assertion Attributes in the SAML Response to sFOX to give additional information about the user","breadcrumbs":[{"label":"Single Sign-On"}]},{"id":"-MlByG-hjtzrUffSO1xB","title":"Error Codes","pathname":"/connect/errors/error-codes","siteSpaceId":"sitesp_RHmzi","description":"","breadcrumbs":[{"label":"Errors"}]}]}