Domain > api-docs.qa.pro.apex.exchange

More information on this domain is in AlienVault OTX

DNS Resolutions

Date	IP Address
2026-01-12	18.164.96.89 (ClassC)
2026-03-04	3.175.34.52 (ClassC)

HTTP/1.1 200 OKContent-Type: text/htmlContent-Length: 1567668Connection: keep-aliveDate: Wed, 04 Mar 2026 06:41:44 GMTLast-Modified: Mon, 24 Mar 2025 13:03:30 GMTETag: 9f49467da496169e16e29187ac21f1cfx-amz-server-side-encryption: AES256Accept-Ranges: bytesServer: AmazonS3X-Cache: Miss from cloudfrontVia: 1.1 17220d5b0843b7d6f37da152096b8a14.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P3X-Amz-Cf-Id: 9lruoJ1QA2nKTcYKX8eCcuurQNB5dcyyehh34BHilllpkGOoHo7KPQ

!doctype html>html> head> link hrefimages/favicon-6f250372.ico relicon typeimage/ico /> meta charsetutf-8> meta contentIEedge,chrome1 http-equivX-UA-Compatible> meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1> meta namedescription contentUSDC Perpetual Contracts Perpetual Swaps Introduction Account User Data API Key Stark Key Setup Endpoint Guides Python SDK > title>Resources & Support — ApeX Pro API Docs/title> style mediascreen> .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight .gh { color: #999999;}.highlight .sr { color: #f6aa11;}.highlight .go { color: #888888;}.highlight .gp { color: #555555;}.highlight .gs {}.highlight .gu { color: #aaaaaa;}.highlight .nb { color: #f6aa11;}.highlight .cm { color: #75715e;}.highlight .cp { color: #75715e;}.highlight .c1 { color: #75715e;}.highlight .cs { color: #75715e;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf { color: #75715e;}.highlight .err { color: #960050;}.highlight .gr { color: #960050;}.highlight .gt { color: #960050;}.highlight .gd { color: #49483e;}.highlight .gi { color: #49483e;}.highlight .ge { color: #49483e;}.highlight .kc { color: #66d9ef;}.highlight .kd { color: #66d9ef;}.highlight .kr { color: #66d9ef;}.highlight .no { color: #66d9ef;}.highlight .kt { color: #66d9ef;}.highlight .mf { color: #ae81ff;}.highlight .mh { color: #ae81ff;}.highlight .il { color: #ae81ff;}.highlight .mi { color: #ae81ff;}.highlight .mo { color: #ae81ff;}.highlight .m, .highlight .mb, .highlight .mx { color: #ae81ff;}.highlight .sc { color: #ae81ff;}.highlight .se { color: #ae81ff;}.highlight .ss { color: #ae81ff;}.highlight .sd { color: #e6db74;}.highlight .s2 { color: #e6db74;}.highlight .sb { color: #e6db74;}.highlight .sh { color: #e6db74;}.highlight .si { color: #e6db74;}.highlight .sx { color: #e6db74;}.highlight .s1 { color: #e6db74;}.highlight .s, .highlight .sa, .highlight .dl { color: #e6db74;}.highlight .na { color: #a6e22e;}.highlight .nc { color: #a6e22e;}.highlight .nd { color: #a6e22e;}.highlight .ne { color: #a6e22e;}.highlight .nf, .highlight .fm { color: #a6e22e;}.highlight .vc { color: #ffffff;}.highlight .nn { color: #ffffff;}.highlight .ni { color: #ffffff;}.highlight .bp { color: #ffffff;}.highlight .vg { color: #ffffff;}.highlight .vi { color: #ffffff;}.highlight .nv, .highlight .vm { color: #ffffff;}.highlight .w { color: #ffffff;}.highlight { color: #ffffff;}.highlight .n, .highlight .py, .highlight .nx { color: #ffffff;}.highlight .nl { color: #f92672;}.highlight .ow { color: #f92672;}.highlight .nt { color: #f92672;}.highlight .k, .highlight .kv { color: #f92672;}.highlight .kn { color: #f92672;}.highlight .kp { color: #f92672;}.highlight .o { color: #f92672;} /style> style mediaprint> * { -webkit-transition:none!important; transition:none!important; } .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight, .highlight .w { color: #586e75;}.highlight .err { color: #002b36; background-color: #dc322f;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs { color: #657b83;}.highlight .cp { color: #b58900;}.highlight .nt { color: #b58900;}.highlight .o, .highlight .ow { color: #93a1a1;}.highlight .p, .highlight .pi { color: #93a1a1;}.highlight .gi { color: #859900;}.highlight .gd { color: #dc322f;}.highlight .gh { color: #268bd2; background-color: #002b36; font-weight: bold;}.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv { color: #6c71c4;}.highlight .kc { color: #cb4b16;}.highlight .kt { color: #cb4b16;}.highlight .kd { color: #cb4b16;}.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 { color: #859900;}.highlight .sa { color: #6c71c4;}.highlight .sr { color: #2aa198;}.highlight .si { color: #d33682;}.highlight .se { color: #d33682;}.highlight .nn { color: #b58900;}.highlight .nc { color: #b58900;}.highlight .no { color: #b58900;}.highlight .na { color: #268bd2;}.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx { color: #859900;}.highlight .ss { color: #859900;} /style> link hrefstylesheets/screen-c9d8fa83.css relstylesheet mediascreen /> link hrefstylesheets/print-953e3353.css relstylesheet mediaprint /> script srcjavascripts/all-b12a2749.js>/script> script> $(function() { setupCodeCopy(); }); /script> /head> body classindex data-languages"shell","python"> a href# idnav-button> span> NAV img srcimages/navbar-cad8cdcb.png alt /> /span> /a> div classtoc-wrapper> img srcimages/logo-3c14d685.svg classlogo alt /> div classlang-selector> a href# data-language-nameshell>shell/a> a href# data-language-namepython>python/a> /div> div classsearch> input typetext classsearch idinput-search placeholderSearch> /div> ul classsearch-results>/ul> ul idtoc classtoc-list-h1> li> a href#introduction classtoc-h1 toc-link data-titleIntroduction>Introduction/a> /li> li> a href#general classtoc-h1 toc-link data-titleGeneral>General/a> ul classtoc-list-h2> li> a href#general-api-resources-and-support-channels classtoc-h2 toc-link data-titleAPI Resources and Support Channels>API Resources and Support Channels/a> /li> li> a href#general-zero-knowledge-rollups classtoc-h2 toc-link data-titleZero-Knowledge Rollups>Zero-Knowledge Rollups/a> /li> li> a href#general-cross-chain-deposits-and-withdrawals classtoc-h2 toc-link data-titleCross-Chain Deposits and Withdrawals>Cross-Chain Deposits and Withdrawals/a> /li> li> a href#general-rest-base-endpoint classtoc-h2 toc-link data-titleREST Base Endpoint:>REST Base Endpoint:/a> /li> li> a href#general-testnet classtoc-h2 toc-link data-titleTestnet>Testnet/a> /li> li> a href#general-query-path-and-parameters classtoc-h2 toc-link data-titleQuery path and Parameters:>Query path and Parameters:/a> /li> li> a href#general-public-api-endpoints-verification-required classtoc-h2 toc-link data-titlePublic API Endpoints (Verification Required)>Public API Endpoints (Verification Required)/a> /li> li> a href#general-private-api-endpoints-authentication-required classtoc-h2 toc-link data-titlePrivate API Endpoints (Authentication Required)>Private API Endpoints (Authentication Required)/a> /li> li> a href#general-1-apikey-signature classtoc-h2 toc-link data-title1. ApiKey Signature>1. ApiKey Signature/a> /li> li> a href#general-2-starkkey-signature classtoc-h2 toc-link data-title2. StarkKey Signature>2. StarkKey Signature/a> /li> li> a href#general-response-parameters classtoc-h2 toc-link data-titleResponse Parameters>Response Parameters/a> /li> li> a href#general-client_id-and-nonce-generation classtoc-h2 toc-link data-titleClient_id and Nonce Generation>Client_id and Nonce Generation/a> /li> li> a href#general-rate-limits classtoc-h2 toc-link data-titleRate Limits>Rate Limits/a> /li> li> a href#general-margin classtoc-h2 toc-link data-titleMargin>Margin/a> /li> li> a href#general-oracle-price classtoc-h2 toc-link data-titleOracle Price>Oracle Price/a> /li> li> a href#general-index-price classtoc-h2 toc-link data-titleIndex Price>Index Price/a> /li> /ul> /li> li> a href#general-v3-for-omni classtoc-h1 toc-link data-titleGeneral V3 for Omni>General V3 for Omni/a> ul classtoc-list-h2> li> a href#general-v3-for-omni-api-resources-and-support-channels classtoc-h2 toc-link data-titleAPI Resources and Support Channels>API Resources and Support Channels/a> /li> li> a href#general-v3-for-omni-rest-base-endpoint classtoc-h2 toc-link data-titleREST Base Endpoint:>REST Base Endpoint:/a> /li> li> a href#general-v3-for-omni-testnet classtoc-h2 toc-link data-titleTestnet>Testnet/a> /li> li> a href#general-v3-for-omni-development classtoc-h2 toc-link data-titleDevelopment>Development/a> /li> li> a href#general-v3-for-omni-installation classtoc-h2 toc-link data-titleInstallation>Installation/a> /li> li> a href#general-v3-for-omni-query-path-and-parameters classtoc-h2 toc-link data-titleQuery path and Parameters:>Query path and Parameters:/a> /li> li> a href#general-v3-for-omni-public-api-endpoints-verification-required classtoc-h2 toc-link data-titlePublic API Endpoints (Verification Required)>Public API Endpoints (Verification Required)/a> /li> li> a href#general-v3-for-omni-private-api-endpoints-authentication-required classtoc-h2 toc-link data-titlePrivate API Endpoints (Authentication Required)>Private API Endpoints (Authentication Required)/a> /li> li> a href#general-v3-for-omni-1-apikey-signature classtoc-h2 toc-link data-title1. ApiKey Signature>1. ApiKey Signature/a> /li> li> a href#general-v3-for-omni-2-zkkeys-signature classtoc-h2 toc-link data-title2. zkKeys Signature>2. zkKeys Signature/a> /li> li> a href#general-v3-for-omni-client_id-and-nonce-generation classtoc-h2 toc-link data-titleClient_id and Nonce Generation>Client_id and Nonce Generation/a> /li> li> a href#general-v3-for-omni-spot-account classtoc-h2 toc-link data-titleSpot Account>Spot Account/a> /li> li> a href#general-v3-for-omni-contract-account classtoc-h2 toc-link data-titleContract Account>Contract Account/a> /li> li> a href#general-v3-for-omni-margin classtoc-h2 toc-link data-titleMargin>Margin/a> /li> li> a href#general-v3-for-omni-index-price classtoc-h2 toc-link data-titleIndex Price>Index Price/a> /li> li> a href#general-v3-for-omni-rate-limits classtoc-h2 toc-link data-titleRate Limits>Rate Limits/a> /li> /ul> /li> li> a href#v2-or-v1 classtoc-h1 toc-link data-titleV2 or V1>V2 or V1/a> ul classtoc-list-h2> li> a href#v2-or-v1-current-api-coverage classtoc-h2 toc-link data-titleCurrent API Coverage>Current API Coverage/a> /li> /ul> /li> li> a href#publicapi-v3-for-omni classtoc-h1 toc-link data-titlePublicApi V3 for Omni>PublicApi V3 for Omni/a> ul classtoc-list-h2> li> a href#publicapi-v3-for-omni-get-system-time-v3 classtoc-h2 toc-link data-titleGET System Time V3>GET System Time V3/a> /li> li> a href#publicapi-v3-for-omni-get-all-config-data-v3 classtoc-h2 toc-link data-titleGET All Config Data V3>GET All Config Data V3/a> /li> li> a href#publicapi-v3-for-omni-get-market-depth-v3 classtoc-h2 toc-link data-titleGET Market Depth V3>GET Market Depth V3/a> /li> li> a href#publicapi-v3-for-omni-get-newest-trading-data-v3 classtoc-h2 toc-link data-titleGET Newest Trading Data V3>GET Newest Trading Data V3/a> /li> li> a href#publicapi-v3-for-omni-get-candlestick-chart-data-v3 classtoc-h2 toc-link data-titleGET Candlestick Chart Data V3>GET Candlestick Chart Data V3/a> /li> li> a href#publicapi-v3-for-omni-get-ticker-data-v3 classtoc-h2 toc-link data-titleGET Ticker Data V3>GET Ticker Data V3/a> /li> li> a href#publicapi-v3-for-omni-get-funding-rate-history-v3 classtoc-h2 toc-link data-titleGET Funding Rate History V3>GET Funding Rate History V3/a> /li> /ul> /li> li> a href#publicapi-v2-for-pro classtoc-h1 toc-link data-titlePublicApi V2 for Pro>PublicApi V2 for Pro/a> ul classtoc-list-h2> li> a href#publicapi-v2-for-pro-get-system-time-v2 classtoc-h2 toc-link data-titleGET System Time V2>GET System Time V2/a> /li> li> a href#publicapi-v2-for-pro-get-all-config-data-v2 classtoc-h2 toc-link data-titleGET All Config Data V2>GET All Config Data V2/a> /li> li> a href#publicapi-v2-for-pro-get-market-depth-v2 classtoc-h2 toc-link data-titleGET Market Depth V2>GET Market Depth V2/a> /li> li> a href#publicapi-v2-for-pro-get-newest-trading-data-v2 classtoc-h2 toc-link data-titleGET Newest Trading Data V2>GET Newest Trading Data V2/a> /li> li> a href#publicapi-v2-for-pro-get-candlestick-chart-data-v2 classtoc-h2 toc-link data-titleGET Candlestick Chart Data V2>GET Candlestick Chart Data V2/a> /li> li> a href#publicapi-v2-for-pro-get-ticker-data-v2 classtoc-h2 toc-link data-titleGET Ticker Data V2>GET Ticker Data V2/a> /li> li> a href#publicapi-v2-for-pro-get-funding-rate-history-v2 classtoc-h2 toc-link data-titleGET Funding Rate History V2>GET Funding Rate History V2/a> /li> li> a href#publicapi-v2-for-pro-get-check-if-user-exists-v2 classtoc-h2 toc-link data-titleGET Check If User Exists V2>GET Check If User Exists V2/a> /li> /ul> /li> li> a href#publicapi classtoc-h1 toc-link data-titlePublicApi>PublicApi/a> ul classtoc-list-h2> li> a href#publicapi-get-system-time classtoc-h2 toc-link data-titleGET System Time>GET System Time/a> /li> li> a href#publicapi-get-all-config-data classtoc-h2 toc-link data-titleGET All Config Data>GET All Config Data/a> /li> li> a href#publicapi-get-market-depth classtoc-h2 toc-link data-titleGET Market Depth>GET Market Depth/a> /li> li> a href#publicapi-get-newest-trading-data classtoc-h2 toc-link data-titleGET Newest Trading Data>GET Newest Trading Data/a> /li> li> a href#publicapi-get-candlestick-chart-data classtoc-h2 toc-link data-titleGET Candlestick Chart Data>GET Candlestick Chart Data/a> /li> li> a href#publicapi-get-ticker-data classtoc-h2 toc-link data-titleGET Ticker Data>GET Ticker Data/a> /li> li> a href#publicapi-get-funding-rate-history classtoc-h2 toc-link data-titleGET Funding Rate History>GET Funding Rate History/a> /li> li> a href#publicapi-get-check-if-user-exists classtoc-h2 toc-link data-titleGET Check If User Exists>GET Check If User Exists/a> /li> /ul> /li> li> a href#privateapi-v3-for-omni classtoc-h1 toc-link data-titlePrivateApi V3 for Omni>PrivateApi V3 for Omni/a> ul classtoc-list-h2> li> a href#privateapi-v3-for-omni-post-generate-nonce classtoc-h2 toc-link data-titlePOST Generate nonce>POST Generate nonce/a> /li> li> a href#privateapi-v3-for-omni-post-registration-amp-onboarding classtoc-h2 toc-link data-titlePOST Registration & Onboarding>POST Registration & Onboarding/a> /li> li> a href#privateapi-v3-for-omni-get-retrieve-user-data classtoc-h2 toc-link data-titleGET Retrieve User Data>GET Retrieve User Data/a> /li> li> a href#privateapi-v3-for-omni-post-edit-user-data classtoc-h2 toc-link data-titlePOST Edit User Data>POST Edit User Data/a> /li> li> a href#privateapi-v3-for-omni-get-retrieve-user-account-data classtoc-h2 toc-link data-titleGET Retrieve User Account Data>GET Retrieve User Account Data/a> /li> li> a href#privateapi-v3-for-omni-get-retrieve-user-account-balance classtoc-h2 toc-link data-titleGET Retrieve User Account balance>GET Retrieve User Account balance/a> /li> li> a href#privateapi-v3-for-omni-get-retrieve-user-deposit-and-withdraw-data classtoc-h2 toc-link data-titleGET Retrieve User Deposit and Withdraw Data>GET Retrieve User Deposit and Withdraw Data/a> /li> li> a href#privateapi-v3-for-omni-post-user-transfer-asset-from-fund-account-to-contract-account classtoc-h2 toc-link data-titlePOST User transfer asset from fund account to contract account>POST User transfer asset from fund account to contract account/a> /li> li> a href#privateapi-v3-for-omni-post-user-transfer-asset-from-contract-account-to-fund-account classtoc-h2 toc-link data-titlePOST User transfer asset from contract account to fund account>POST User transfer asset from contract account to fund account/a> /li> li> a href#privateapi-v3-for-omni-post-user-withdrawal classtoc-h2 toc-link data-titlePOST User Withdrawal>POST User Withdrawal/a> /li> li> a href#privateapi-v3-for-omni-get-withdrawal-fees classtoc-h2 toc-link data-titleGET Withdrawal Fees>GET Withdrawal Fees/a> /li> li> a href#privateapi-v3-for-omni-get-contract-account-transfer-limits classtoc-h2 toc-link data-titleGET Contract Account Transfer Limits>GET Contract Account Transfer Limits/a> /li> li> a href#privateapi-v3-for-omni-get-trade-history classtoc-h2 toc-link data-titleGET Trade History>GET Trade History/a> /li> li> a href#privateapi-v3-for-omni-get-worst-price classtoc-h2 toc-link data-titleGET Worst Price>GET Worst Price/a> /li> li> a href#privateapi-v3-for-omni-post-creating-orders classtoc-h2 toc-link data-titlePOST Creating Orders>POST Creating Orders/a> /li> li> a href#privateapi-v3-for-omni-post-cancel-order classtoc-h2 toc-link data-titlePOST Cancel Order>POST Cancel Order/a> /li> li> a href#privateapi-v3-for-omni-post-cancel-order-by-clientorderid classtoc-h2 toc-link data-titlePOST Cancel Order By ClientOrderId>POST Cancel Order By ClientOrderId/a> /li> li> a href#privateapi-v3-for-omni-get-open-orders classtoc-h2 toc-link data-titleGET Open Orders>GET Open Orders/a> /li> li> a href#privateapi-v3-for-omni-post-cancel-all-open-orders classtoc-h2 toc-link data-titlePOST Cancel all Open Orders>POST Cancel all Open Orders/a> /li> li> a href#privateapi-v3-for-omni-get-all-order-history classtoc-h2 toc-link data-titleGET All Order History>GET All Order History/a> /li> li> a href#privateapi-v3-for-omni-get-order-id classtoc-h2 toc-link data-titleGET Order ID>GET Order ID/a> /li> li> a href#privateapi-v3-for-omni-get-order-by-clientorderid classtoc-h2 toc-link data-titleGET Order by clientOrderId>GET Order by clientOrderId/a> /li> li> a href#privateapi-v3-for-omni-get-funding-rate classtoc-h2 toc-link data-titleGET Funding Rate>GET Funding Rate/a> /li> li> a href#privateapi-v3-for-omni-get-user-historial-profit-and-loss classtoc-h2 toc-link data-titleGET User Historial Profit and Loss>GET User Historial Profit and Loss/a> /li> li> a href#privateapi-v3-for-omni-get-yesterday-39-s-profit-amp-loss classtoc-h2 toc-link data-titleGET Yesterdays Profit & Loss>GET Yesterdays Profit & Loss/a> /li> li> a href#privateapi-v3-for-omni-get-historical-asset-value classtoc-h2 toc-link data-titleGET Historical Asset Value>GET Historical Asset Value/a> /li> li> a href#privateapi-v3-for-omni-post-sets-the-initial-margin-rate-of-a-contract classtoc-h2 toc-link data-titlePOST Sets the initial margin rate of a contract>POST Sets the initial margin rate of a contract/a> /li> li> a href#privateapi-v3-for-omni-get-repayment-price-v3 classtoc-h2 toc-link data-titleGET Repayment price V3>GET Repayment price V3/a> /li> li> a href#privateapi-v3-for-omni-post-user-manual-repayment-v3 classtoc-h2 toc-link data-titlePOST User manual repayment V3>POST User manual repayment V3/a> /li> /ul> /li> li> a href#privateapi-v2-for-pro classtoc-h1 toc-link data-titlePrivateApi V2 for Pro>PrivateApi V2 for Pro/a> ul classtoc-list-h2> li> a href#privateapi-v2-for-pro-post-generate-nonce-v2 classtoc-h2 toc-link data-titlePOST Generate nonce V2>POST Generate nonce V2/a> /li> li> a href#privateapi-v2-for-pro-post-registration-amp-onboarding-v2 classtoc-h2 toc-link data-titlePOST Registration & Onboarding V2>POST Registration & Onboarding V2/a> /li> li> a href#privateapi-v2-for-pro-get-retrieve-user-data-v2 classtoc-h2 toc-link data-titleGET Retrieve User Data V2>GET Retrieve User Data V2/a> /li> li> a href#privateapi-v2-for-pro-post-edit-user-data-v2 classtoc-h2 toc-link data-titlePOST Edit User Data V2>POST Edit User Data V2/a> /li> li> a href#privateapi-v2-for-pro-get-retrieve-user-account-data-v2 classtoc-h2 toc-link data-titleGET Retrieve User Account Data V2>GET Retrieve User Account Data V2/a> /li> li> a href#privateapi-v2-for-pro-get-retrieve-user-account-balance-v2 classtoc-h2 toc-link data-titleGET Retrieve User Account balance V2>GET Retrieve User Account balance V2/a> /li> li> a href#privateapi-v2-for-pro-get-retrieve-user-deposit-data-v2 classtoc-h2 toc-link data-titleGET Retrieve User Deposit Data V2>GET Retrieve User Deposit Data V2/a> /li> li> a href#privateapi-v2-for-pro-get-retrieve-user-withdrawal-list-v2 classtoc-h2 toc-link data-titleGET Retrieve User Withdrawal List V2>GET Retrieve User Withdrawal List V2/a> /li> li> a href#privateapi-v2-for-pro-post-user-withdrawal-v2 classtoc-h2 toc-link data-titlePOST User Withdrawal V2>POST User Withdrawal V2/a> /li> li> a href#privateapi-v2-for-pro-post-user-withdrawal-to-designated-address-v2 classtoc-h2 toc-link data-titlePOST User Withdrawal to Designated Address V2>POST User Withdrawal to Designated Address V2/a> /li> li> a href#privateapi-v2-for-pro-post-user-fast-withdrawal-v2 classtoc-h2 toc-link data-titlePOST User Fast Withdrawal V2>POST User Fast Withdrawal V2/a> /li> li> a href#privateapi-v2-for-pro-post-cross-chain-withdrawals-v2 classtoc-h2 toc-link data-titlePOST Cross-Chain Withdrawals V2>POST Cross-Chain Withdrawals V2/a> /li> li> a href#privateapi-v2-for-pro-get-fast-amp-cross-chain-withdrawal-fees-v2 classtoc-h2 toc-link data-titleGET Fast & Cross-Chain Withdrawal Fees V2>GET Fast & Cross-Chain Withdrawal Fees V2/a> /li> li> a href#privateapi-v2-for-pro-get-withdrawal-amp-transfer-limits-v2 classtoc-h2 toc-link data-titleGET Withdrawal & Transfer Limits V2>GET Withdrawal & Transfer Limits V2/a> /li> li> a href#privateapi-v2-for-pro-get-trade-history classtoc-h2 toc-link data-titleGET Trade History>GET Trade History/a> /li> li> a href#privateapi-v2-for-pro-get-worst-price-v2 classtoc-h2 toc-link data-titleGET Worst Price V2>GET Worst Price V2/a> /li> li> a href#privateapi-v2-for-pro-post-creating-orders-v2 classtoc-h2 toc-link data-titlePOST Creating Orders V2>POST Creating Orders V2/a> /li> li> a href#privateapi-v2-for-pro-post-cancel-order-v2 classtoc-h2 toc-link data-titlePOST Cancel Order V2>POST Cancel Order V2/a> /li> li> a href#privateapi-v2-for-pro-post-cancel-order-by-clientorderid classtoc-h2 toc-link data-titlePOST Cancel Order By ClientOrderId>POST Cancel Order By ClientOrderId/a> /li> li> a href#privateapi-v2-for-pro-get-open-orders-v2 classtoc-h2 toc-link data-titleGET Open Orders V2>GET Open Orders V2/a> /li> li> a href#privateapi-v2-for-pro-post-cancel-all-open-orders-v2 classtoc-h2 toc-link data-titlePOST Cancel all Open Orders V2>POST Cancel all Open Orders V2/a> /li> li> a href#privateapi-v2-for-pro-get-all-order-history-v2 classtoc-h2 toc-link data-titleGET All Order History V2>GET All Order History V2/a> /li> li> a href#privateapi-v2-for-pro-get-order-id-v2 classtoc-h2 toc-link data-titleGET Order ID V2>GET Order ID V2/a> /li> li> a href#privateapi-v2-for-pro-get-order-by-clientorderid-v2 classtoc-h2 toc-link data-titleGET Order by clientOrderId V2>GET Order by clientOrderId V2/a> /li> li> a href#privateapi-v2-for-pro-get-funding-rate-v2 classtoc-h2 toc-link data-titleGET Funding Rate V2>GET Funding Rate V2/a> /li> li> a href#privateapi-v2-for-pro-get-user-historial-profit-and-loss-v2 classtoc-h2 toc-link data-titleGET User Historial Profit and Loss V2>GET User Historial Profit and Loss V2/a> /li> li> a href#privateapi-v2-for-pro-get-yesterday-39-s-profit-amp-loss-v2 classtoc-h2 toc-link data-titleGET Yesterdays Profit & Loss V2>GET Yesterdays Profit & Loss V2/a> /li> li> a href#privateapi-v2-for-pro-get-historical-asset-value classtoc-h2 toc-link data-titleGET Historical Asset Value>GET Historical Asset Value/a> /li> li> a href#privateapi-v2-for-pro-post-sets-the-initial-margin-rate-of-a-contract-v2 classtoc-h2 toc-link data-titlePOST Sets the initial margin rate of a contract V2>POST Sets the initial margin rate of a contract V2/a> /li> /ul> /li> li> a href#privateapi classtoc-h1 toc-link data-titlePrivateApi>PrivateApi/a> ul classtoc-list-h2> li> a href#privateapi-post-generate-nonce classtoc-h2 toc-link data-titlePOST Generate nonce>POST Generate nonce/a> /li> li> a href#privateapi-post-registration-amp-onboarding classtoc-h2 toc-link data-titlePOST Registration & Onboarding>POST Registration & Onboarding/a> /li> li> a href#privateapi-get-retrieve-user-data classtoc-h2 toc-link data-titleGET Retrieve User Data>GET Retrieve User Data/a> /li> li> a href#privateapi-post-edit-user-data classtoc-h2 toc-link data-titlePOST Edit User Data>POST Edit User Data/a> /li> li> a href#privateapi-get-retrieve-user-account-data classtoc-h2 toc-link data-titleGET Retrieve User Account Data>GET Retrieve User Account Data/a> /li> li> a href#privateapi-get-retrieve-user-account-balance classtoc-h2 toc-link data-titleGET Retrieve User Account balance>GET Retrieve User Account balance/a> /li> li> a href#privateapi-get-retrieve-user-deposit-data classtoc-h2 toc-link data-titleGET Retrieve User Deposit Data>GET Retrieve User Deposit Data/a> /li> li> a href#privateapi-get-retrieve-user-withdrawal-list classtoc-h2 toc-link data-titleGET Retrieve User Withdrawal List>GET Retrieve User Withdrawal List/a> /li> li> a href#privateapi-post-user-withdrawal classtoc-h2 toc-link data-titlePOST User Withdrawal>POST User Withdrawal/a> /li> li> a href#privateapi-post-user-withdrawal-to-designated-address classtoc-h2 toc-link data-titlePOST User Withdrawal to Designated Address>POST User Withdrawal to Designated Address/a> /li> li> a href#privateapi-post-user-fast-withdrawal classtoc-h2 toc-link data-titlePOST User Fast Withdrawal>POST User Fast Withdrawal/a> /li> li> a href#privateapi-post-cross-chain-withdrawals classtoc-h2 toc-link data-titlePOST Cross-Chain Withdrawals>POST Cross-Chain Withdrawals/a> /li> li> a href#privateapi-get-fast-amp-cross-chain-withdrawal-fees classtoc-h2 toc-link data-titleGET Fast & Cross-Chain Withdrawal Fees>GET Fast & Cross-Chain Withdrawal Fees/a> /li> li> a href#privateapi-get-withdrawal-amp-transfer-limits classtoc-h2 toc-link data-titleGET Withdrawal & Transfer Limits>GET Withdrawal & Transfer Limits/a> /li> li> a href#privateapi-get-trade-history classtoc-h2 toc-link data-titleGET Trade History>GET Trade History/a> /li> li> a href#privateapi-get-worst-price classtoc-h2 toc-link data-titleGET Worst Price>GET Worst Price/a> /li> li> a href#privateapi-post-creating-orders classtoc-h2 toc-link data-titlePOST Creating Orders>POST Creating Orders/a> /li> li> a href#privateapi-post-cancel-order classtoc-h2 toc-link data-titlePOST Cancel Order>POST Cancel Order/a> /li> li> a href#privateapi-post-cancel-order-by-clientorderid classtoc-h2 toc-link data-titlePOST Cancel Order By ClientOrderId>POST Cancel Order By ClientOrderId/a> /li> li> a href#privateapi-get-open-orders classtoc-h2 toc-link data-titleGET Open Orders>GET Open Orders/a> /li> li> a href#privateapi-post-cancel-all-open-orders classtoc-h2 toc-link data-titlePOST Cancel all Open Orders>POST Cancel all Open Orders/a> /li> li> a href#privateapi-get-all-order-history classtoc-h2 toc-link data-titleGET All Order History>GET All Order History/a> /li> li> a href#privateapi-get-order-id classtoc-h2 toc-link data-titleGET Order ID>GET Order ID/a> /li> li> a href#privateapi-get-order-by-clientorderid classtoc-h2 toc-link data-titleGET Order by clientOrderId>GET Order by clientOrderId/a> /li> li> a href#privateapi-get-verification-email-link classtoc-h2 toc-link data-titleGET Verification Email Link>GET Verification Email Link/a> /li> li> a href#privateapi-post-link-device classtoc-h2 toc-link data-titlePOST Link Device>POST Link Device/a> /li> li> a href#privateapi-get-funding-rate classtoc-h2 toc-link data-titleGET Funding Rate>GET Funding Rate/a> /li> li> a href#privateapi-get-user-historial-profit-and-loss classtoc-h2 toc-link data-titleGET User Historial Profit and Loss>GET User Historial Profit and Loss/a> /li> li> a href#privateapi-get-yesterday-39-s-profit-amp-loss classtoc-h2 toc-link data-titleGET Yesterdays Profit & Loss>GET Yesterdays Profit & Loss/a> /li> li> a href#privateapi-get-historical-asset-value classtoc-h2 toc-link data-titleGET Historical Asset Value>GET Historical Asset Value/a> /li> li> a href#privateapi-post-sets-the-initial-margin-rate-of-a-contract classtoc-h2 toc-link data-titlePOST Sets the initial margin rate of a contract>POST Sets the initial margin rate of a contract/a> /li> /ul> /li> li> a href#starkkey-signature classtoc-h1 toc-link data-titleStarkKey Signature>StarkKey Signature/a> ul classtoc-list-h2> li> a href#starkkey-signature-create-order classtoc-h2 toc-link data-titleCreate Order>Create Order/a> /li> li> a href#starkkey-signature-withdrawal classtoc-h2 toc-link data-titleWithdrawal>Withdrawal/a> /li> li> a href#starkkey-signature-withdrawal-to-address classtoc-h2 toc-link data-titleWithdrawal to Address>Withdrawal to Address/a> /li> li> a href#starkkey-signature-cross-chain-withdrawal classtoc-h2 toc-link data-titleCross-Chain Withdrawal>Cross-Chain Withdrawal/a> /li> li> a href#starkkey-signature-conditional-transfer classtoc-h2 toc-link data-titleConditional Transfer>Conditional Transfer/a> /li> /ul> /li> li> a href#websocket-v3-for-omni classtoc-h1 toc-link data-titleWebsocket V3 for Omni>Websocket V3 for Omni/a> ul classtoc-list-h2> li> a href#websocket-v3-for-omni-websocket-v3-endpoint classtoc-h2 toc-link data-titleWebsocket V3 Endpoint:>Websocket V3 Endpoint:/a> /li> /ul> /li> li> a href#public-websocket-v3 classtoc-h1 toc-link data-titlePublic Websocket V3>Public Websocket V3/a> ul classtoc-list-h2> li> a href#public-websocket-v3-heartbeat-packet classtoc-h2 toc-link data-titleHeartbeat Packet>Heartbeat Packet/a> /li> li> a href#public-websocket-v3-how-to-subscribe-to-topics classtoc-h2 toc-link data-titleHow to Subscribe to Topics>How to Subscribe to Topics/a> /li> li> a href#public-websocket-v3-depth classtoc-h2 toc-link data-titleDepth>Depth/a> /li> li> a href#public-websocket-v3-trade classtoc-h2 toc-link data-titleTrade>Trade/a> /li> li> a href#public-websocket-v3-ticker classtoc-h2 toc-link data-titleTicker>Ticker/a> /li> li> a href#public-websocket-v3-candlestick-chart classtoc-h2 toc-link data-titleCandlestick Chart>Candlestick Chart/a> /li> li> a href#public-websocket-v3-all-tickers classtoc-h2 toc-link data-titleAll Tickers>All Tickers/a> /li> /ul> /li> li> a href#private-websocket-v3 classtoc-h1 toc-link data-titlePrivate Websocket V3>Private Websocket V3/a> ul classtoc-list-h2> li> a href#private-websocket-v3-send-authority-request classtoc-h2 toc-link data-titleSend Authority Request>Send Authority Request/a> /li> li> a href#private-websocket-v3-subscription-success-push-data classtoc-h2 toc-link data-titleSubscription Success Push Data>Subscription Success Push Data/a> /li> li> a href#private-websocket-v3-order-submission-push classtoc-h2 toc-link data-titleOrder Submission Push>Order Submission Push/a> /li> li> a href#private-websocket-v3-post-submission-of-maker-order-push classtoc-h2 toc-link data-titlePost-Submission of Maker Order Push>Post-Submission of Maker Order Push/a> /li> li> a href#private-websocket-v3-post-cancel-order-push classtoc-h2 toc-link data-titlePost-Cancel Order Push>Post-Cancel Order Push/a> /li> li> a href#private-websocket-v3-successful-order-execution-push classtoc-h2 toc-link data-titleSuccessful Order Execution Push>Successful Order Execution Push/a> /li> li> a href#private-websocket-v3-deposit-success-push classtoc-h2 toc-link data-titleDeposit Success Push>Deposit Success Push/a> /li> li> a href#private-websocket-v3-withdrawal-request-submission-push classtoc-h2 toc-link data-titleWithdrawal Request Submission Push>Withdrawal Request Submission Push/a> /li> li> a href#private-websocket-v3-notify-message-push classtoc-h2 toc-link data-titleNotify Message Push>Notify Message Push/a> /li> li> a href#private-websocket-v3-new-notification-message-push classtoc-h2 toc-link data-titleNew Notification Message Push>New Notification Message Push/a> /li> /ul> /li> li> a href#websocket-v2-for-pro classtoc-h1 toc-link data-titleWebsocket V2 for Pro>Websocket V2 for Pro/a> ul classtoc-list-h2> li> a href#websocket-v2-for-pro-websocket-endpoint classtoc-h2 toc-link data-titleWebsocket Endpoint:>Websocket Endpoint:/a> /li> /ul> /li> li> a href#public-websocket-v2 classtoc-h1 toc-link data-titlePublic Websocket V2>Public Websocket V2/a> ul classtoc-list-h2> li> a href#public-websocket-v2-heartbeat-packet classtoc-h2 toc-link data-titleHeartbeat Packet>Heartbeat Packet/a> /li> li> a href#public-websocket-v2-how-to-subscribe-to-topics classtoc-h2 toc-link data-titleHow to Subscribe to Topics>How to Subscribe to Topics/a> /li> li> a href#public-websocket-v2-depth classtoc-h2 toc-link data-titleDepth>Depth/a> /li> li> a href#public-websocket-v2-trade classtoc-h2 toc-link data-titleTrade>Trade/a> /li> li> a href#public-websocket-v2-ticker classtoc-h2 toc-link data-titleTicker>Ticker/a> /li> li> a href#public-websocket-v2-candlestick-chart classtoc-h2 toc-link data-titleCandlestick Chart>Candlestick Chart/a> /li> li> a href#public-websocket-v2-all-tickers classtoc-h2 toc-link data-titleAll Tickers>All Tickers/a> /li> /ul> /li> li> a href#private-websocket-v2 classtoc-h1 toc-link data-titlePrivate Websocket V2>Private Websocket V2/a> ul classtoc-list-h2> li> a href#private-websocket-v2-send-authority-request classtoc-h2 toc-link data-titleSend Authority Request>Send Authority Request/a> /li> li> a href#private-websocket-v2-subscription-success-push-data classtoc-h2 toc-link data-titleSubscription Success Push Data>Subscription Success Push Data/a> /li> li> a href#private-websocket-v2-order-submission-push classtoc-h2 toc-link data-titleOrder Submission Push>Order Submission Push/a> /li> li> a href#private-websocket-v2-post-submission-of-maker-order-push classtoc-h2 toc-link data-titlePost-Submission of Maker Order Push>Post-Submission of Maker Order Push/a> /li> li> a href#private-websocket-v2-post-cancel-order-push classtoc-h2 toc-link data-titlePost-Cancel Order Push>Post-Cancel Order Push/a> /li> li> a href#private-websocket-v2-successful-order-execution-push classtoc-h2 toc-link data-titleSuccessful Order Execution Push>Successful Order Execution Push/a> /li> li> a href#private-websocket-v2-deposit-success-push classtoc-h2 toc-link data-titleDeposit Success Push>Deposit Success Push/a> /li> li> a href#private-websocket-v2-withdrawal-request-submission-push classtoc-h2 toc-link data-titleWithdrawal Request Submission Push>Withdrawal Request Submission Push/a> /li> li> a href#private-websocket-v2-notify-message-push classtoc-h2 toc-link data-titleNotify Message Push>Notify Message Push/a> /li> li> a href#private-websocket-v2-new-notification-message-push classtoc-h2 toc-link data-titleNew Notification Message Push>New Notification Message Push/a> /li> /ul> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers classtoc-h1 toc-link data-titleGnosis Multi-Sig Wallet Endpoint for Market Makers>Gnosis Multi-Sig Wallet Endpoint for Market Makers/a> ul classtoc-list-h2> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-creating-a-gnosis-safe-multi-sig-wallet classtoc-h2 toc-link data-titleCreating a Gnosis Safe Multi-Sig Wallet>Creating a Gnosis Safe Multi-Sig Wallet/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-starkware-smart-contract-abi-code classtoc-h2 toc-link data-titleStarkWare Smart Contract ABI Code>StarkWare Smart Contract ABI Code/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-generating-apexpro-l2key-account classtoc-h2 toc-link data-titleGenerating ApexPro L2key Account>Generating ApexPro L2key Account/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-authorize-starkware-contract-to-transfer-usdc-via-gnosis-safe classtoc-h2 toc-link data-titleAuthorize StarkWare Contract to Transfer USDC via Gnosis Safe>Authorize StarkWare Contract to Transfer USDC via Gnosis Safe/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-deposit-via-gnosis-safe classtoc-h2 toc-link data-titleDeposit via Gnosis Safe>Deposit via Gnosis Safe/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-checking-for-withdrawable-balance-with-gnosis-safe classtoc-h2 toc-link data-titleChecking for Withdrawable Balance With Gnosis Safe>Checking for Withdrawable Balance With Gnosis Safe/a> /li> li> a href#gnosis-multi-sig-wallet-endpoint-for-market-makers-initiating-withdrawals-with-gnosis-safe classtoc-h2 toc-link data-titleInitiating Withdrawals With Gnosis Safe>Initiating Withdrawals With Gnosis Safe/a> /li> /ul> /li> li> a href#q-amp-a classtoc-h1 toc-link data-titleQ & A>Q & A/a> ul classtoc-list-h2> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-1-q-what-is-the-easiest-way-to-get-started-with-the-api-sdk classtoc-h2 toc-link data-title1. Q: What is the easiest way to get started with the API SDK?>1. Q: What is the easiest way to get started with the API SDK?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-2-q-what-is-an-apikey-what-is-a-starkkey classtoc-h2 toc-link data-title2. Q: What is an APIKey? What is a StarkKey?>2. Q: What is an APIKey? What is a StarkKey?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-3-q-what-is-a-limit-fee-what-is-a-limit-fee-rate classtoc-h2 toc-link data-title3. Q: What is a Limit Fee? What is a Limit Fee Rate?>3. Q: What is a Limit Fee? What is a Limit Fee Rate?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-4-q-what-is-the-expiration-time classtoc-h2 toc-link data-title4. Q: What is the expiration time?>4. Q: What is the expiration time?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-5-q-what-is-a-clientid classtoc-h2 toc-link data-title5. Q: What is a clientId?>5. Q: What is a clientId?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-6-q-is-the-starkkey-generated-consistently-every-time classtoc-h2 toc-link data-title6. Q: Is the StarkKey generated consistently every time?>6. Q: Is the StarkKey generated consistently every time?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-7-q-is-apikey-generated-consistently-every-time classtoc-h2 toc-link data-title7. Q: Is Apikey generated consistently every time?>7. Q: Is Apikey generated consistently every time?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-8-q-are-there-any-rate-limits-on-request-frequency classtoc-h2 toc-link data-title8. Q: Are there any rate limits on request frequency?>8. Q: Are there any rate limits on request frequency?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-9-q-why-do-i-have-to-fill-in-the-price-when-creating-a-market-order classtoc-h2 toc-link data-title9. Q: Why do I have to fill in the price when creating a market order?>9. Q: Why do I have to fill in the price when creating a market order?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-10-q-how-to-calculate-user-39-s-total-assets-available-balance-maintenance-margin-etc classtoc-h2 toc-link data-title10. Q: How to calculate users total assets, available balance, maintenance margin, etc？>10. Q: How to calculate users total assets, available balance, maintenance margin, etc？/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-11-q-in-which-region-is-the-server-located-in-aws classtoc-h2 toc-link data-title11. Q: In which region is the server located in AWS?>11. Q: In which region is the server located in AWS?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-12-q-how-do-i-set-limitfee-when-creating-orders-using-the-python-sdk classtoc-h2 toc-link data-title12. Q: How do I set LimitFee when creating orders using the Python SDK?>12. Q: How do I set LimitFee when creating orders using the Python SDK?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-13-q-how-many-apikeys-can-be-created-at-most-for-one-account classtoc-h2 toc-link data-title13. Q: How many APIKeys can be created at most for one account?>13. Q: How many APIKeys can be created at most for one account?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-14-q-when-creating-an-order-using-the-python-sdk-what-happens-if-you-fill-in-numbers-directly classtoc-h2 toc-link data-title14. Q: When creating an order using the Python SDK, what happens if you fill in numbers directly?>14. Q: When creating an order using the Python SDK, what happens if you fill in numbers directly?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-15-q-which-python-version-does-the-python-sdk-use classtoc-h2 toc-link data-title15. Q: Which Python version does the Python SDK use?>15. Q: Which Python version does the Python SDK use?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-16-q-can-i-use-a-usdt-account-directly-if-i-have-used-a-usdc-account-before classtoc-h2 toc-link data-title16. Q: Can I use a USDT account directly if I have used a USDC account before?>16. Q: Can I use a USDT account directly if I have used a USDC account before?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-17-q-can-token-deposits-and-withdrawals-be-performed-through-the-api classtoc-h2 toc-link data-title17. Q: Can token deposits and withdrawals be performed through the API?>17. Q: Can token deposits and withdrawals be performed through the API?/a> /li> li> a href#q-amp-a-initiating-withdrawals-with-gnosis-safe-18-q-is-it-necessary-to-obtain-configuration-information classtoc-h2 toc-link data-title18. Q: Is it necessary to obtain configuration information?>18. Q: Is it necessary to obtain configuration information?/a> /li> /ul> /li> li> a href#errors classtoc-h1 toc-link data-titleErrors>Errors/a> /li> /ul> /div> div classpage-wrapper> div classdark-box>/div> div classcontent> h1 idintroduction>Introduction/h1>p>We have language bindings in Shell, Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right./p>h1 idgeneral>General/h1>p>v1.0.0 /p>h2 idgeneral-api-resources-and-support-channels>API Resources and Support Channels/h2>ul>li>a hrefhttps://pro.apex.exchange/>Home/a> - Access and manage your trades./li>li>OpenApi-SDK/li>li>- a hrefhttps://github.com/ApeX-Protocol/apexpro-openapi>OpenApi-Python-SDK/a> - Official OpenApi Python SDK/li>li>- a hrefhttps://github.com/ApeX-Protocol/apexpro-connector-java>OpenApi-Java-SDK/a> - Official OpenApi JAVA SDK/li>li>- a hrefhttps://github.com/ApeX-Protocol/apexpro-connector-node>OpenApi-Node.JS-SDK/a> - Official OpenApi Node JS SDK/li>li>a hrefhttps://t.me/ApeXdex>Telegram/a> - Discussion Chat Group/li>li>a hrefhttps://www.apex.exchange/discord>Discord/a> - Official Discussion Discord Group/li>li>a hrefhttps://twitter.com/OfficialApeXdex>Twitter/a> - Official Twitter Channel/li>/ul>h2 idgeneral-zero-knowledge-rollups>Zero-Knowledge Rollups/h2>p>On-chain data availability and integrity can be ensured with StarkWare’s STARK proofs, a form of zero-knowledge proof (ZK-proof) technology that will help safeguard a fully non-custodial protocol. Built on the Ethereum network, this Layer 2 architecture publishes ZK-proofs directly to Ethereum smart contracts for verification. Transactions are also uniquely packaged for publishing on-chain for traders concerned about data privacy as only balance charges will be made visible./p>h2 idgeneral-cross-chain-deposits-and-withdrawals>Cross-Chain Deposits and Withdrawals/h2>p>Support for the deposits and withdrawals for EVM-compatible chains are available on ApeX Pro. Tokens will be converted to USDC via the 1inch API protocol swap./p>h3 idgeneral-cross-chain-deposits-and-withdrawals-cross-chain-deposits>Cross-Chain Deposits/h3>p>ApeX Pro has built multiple asset pools on different chains. When users deposit assets from a non-Ethereum chain, ApeX Pro will transfer an equivalent amount of assets to the user's L2 account through its corresponding asset pool, built on the respective chain.br>When a user deposit USDC from A chain, ApeX Pro could transfer the corresponding amount USDC to the user's account in L2 through its own asset pool./p>h3 idgeneral-cross-chain-deposits-and-withdrawals-cross-chain-withdrawal>Cross-Chain Withdrawal/h3>p>You can withdraw assets directly to different chain on ApeX Pro. When a user withdraws their assets to an EVM-compatible chain, the asset will first be transferred to ApeX Pro's L2 asset pool. Thereafter, ApeX Pro will transfer the corresponding amount of assets to the user's address from its own asset pool on the corresponding withdrawal chain.br>Please note that the maximum withdrawal amount is not only limited by the total assets available in a user’s account, but also needs to be less than the maximum available amount of the chain's asset pool./p>h3 idgeneral-cross-chain-deposits-and-withdrawals-example>Example:/h3>p>Assume that there is 10,000 USDC available in Alice's account. Alice wants to withdraw 10,000 USDC via the Polygon chain, but only 8,000 USDC is available in Polygon's asset pool on ApeX Pro. The system will inform Alice that the current available assets in the Polygon chain are insufficient and prompt Alice to withdraw from another chain.br>Alice has two choices. She either withdraws 8,000 USDC or less from the Polygon chain and withdraw the remainder of her balance via another chain or proceed to withdraw 10,000 USDC via another chain of which assets pools has sufficient funds to process the withdrawal request.br>Traders can safely and easily proceed with deposit and withdrawal transactions via preferred chain on ApeX Pro.br>ApeX Pro will also use a monitoring program to adjust the balance of funds across chains to ensure sufficient assets in varying asset pools at any one time./p>h2 idgeneral-rest-base-endpoint>REST Base Endpoint:/h2>h3 idgeneral-rest-base-endpoint-testnet>Testnet:/h3>p>code>https://testnet.pro.apex.exchange/api//code>/p>h3 idgeneral-rest-base-endpoint-mainnet>Mainnet:/h3>p>code>https://pro.apex.exchange/api//code>/p>h2 idgeneral-testnet>Testnet/h2>ul>li>ApeX Pro's testnet can be found on code>https://testnet.pro.apex.exchange/code>, built on the Goerli test network. /li>li>You can obtain assets for use on the testnet via the faucet here code>https://testnet.pro.apex.exchange/faucet/code>./li>li>ApeX Pro's USDC Token Address (Goerli Testnet): code>0xd44BB808bfE43095dBb94c83077766382D63952a/code>br>/li>/ul>h2 idgeneral-query-path-and-parameters>Query path and Parameters:/h2>ul>li>You must include ApeX Pro's version number in the url path, e.g. v1, v2./li>li>The parameter "url path" is not case-sensitive and lower case letters will be displayed by default. The en-dash (-) can be used as spaces between individual words./li>li>The HTTP endpoint parameters are in camel case, opening with lower case letters./li>li>Due to different time zones with time parameters, please use int64 across all instances by default./li>li>Randomly generated id and numbers may be long in length and considering that the js display may be intercepted, these will be reflected as a string by default/li>li>For customized request headers, please enter key in upper case and use the en-dash (-) as spaces between individual words./li>/ul>h3 idgeneral-query-path-and-parameters-http-get-request>Http Get Request/h3>p>Please add parameters to the query path.asbr>code>https://pro.apex.exchange/api/v1/transfers?limit100&page1&currencyIdUSDC&chainIds1/code>/p>h3 idgeneral-query-path-and-parameters-http-post-request>Http Post Request/h3>p>Enter order data in body, in the content-type x-www-form-urlencoded. You do not need to encode your data. as code>starkKeyxxx&ethAddressyyy&chainIdzzz/code>/p>h2 idgeneral-public-api-endpoints-verification-required>Public API Endpoints (Verification Required)/h2>p>a href/#publicapi>publicApi/a>/p>h2 idgeneral-private-api-endpoints-authentication-required>Private API Endpoints (Authentication Required)/h2>p>a href/#privateapi>privateApi/a> /p>p>All requests made to private endpoints must be authenticated. The following signatures must be used for authentication:/p>h2 idgeneral-1-apikey-signature>1. ApiKey Signature/h2>ul>li>An apiKey signature is required for all private API endpoints/li>li>Users can obtain and save their public and private apiKey via wallet signature verification on ApeX Pro desktop or app/li>li>API trading users can utilize python-sdk to generate the private and public key pair for apiKey and save them for future API requests, refer to python sdkbr>/li>/ul>blockquote>p>Generate apiKey/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>import osimport sysfrom apexpro.http_private import HttpPrivatefrom apexpro.constants import APEX_HTTP_MAIN, NETWORKID_MAINclient span classo>/span> HttpPrivatespan classo>(/span>APEX_HTTP_MAIN, span classnv>network_id/span>span classo>/span>NETWORKID_MAIN, span classnv>eth_private_key/span>span classo>/span>span classs2>0x*****/span>span classo>)/span>configs span classo>/span> client.configsspan classo>()/span>stark_key_pair_with_y_coordinate span classo>/span> client.derive_stark_keyspan classo>(/span>client.default_addressspan classo>)/span>nonceRes span classo>/span> client.generate_noncespan classo>(/span>span classnv>starkKey/span>span classo>/span>stark_key_pair_with_y_coordinatespan classs1>public_key/span>span classo>/span>,ethAddressspan classo>/span>client.default_address,chainIdspan classo>/span>span classs2>1/span>span classo>)/span>regRes span classo>/span> client.register_userspan classo>(/span>span classnv>nonce/span>span classo>/span>nonceResspan classs1>data/span>span classo>/span>span classs1>nonce/span>span classo>/span>,starkKeyspan classo>/span>stark_key_pair_with_y_coordinatespan classs1>public_key/span>span classo>/span>,stark_public_key_y_coordinatespan classo>/span>stark_key_pair_with_y_coordinatespan classs1>public_key_y_coordinate/span>span classo>/span>,ethereum_addressspan classo>/span>client.default_addressspan classo>)/span>key span classo>/span> regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>key/span>span classo>/span>secret span classo>/span> regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>secret/span>span classo>/span>passphrase span classo>/span> regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>passphrase/span>span classo>/span>span classc>#back stark_key_pair, apiKey,and accountId for private Api or create-oreder or withdraw/span>printspan classo>(/span>stark_key_pair_with_y_coordinatespan classo>)/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>account/span>span classo>/span>span classs1>positionId/span>span classo>)/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>)/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>sys/span>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classs>0x*****/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs/span>span classp>()/span>span classn>stark_key_pair_with_y_coordinate/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_stark_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce/span>span classp>(/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>1/span>span classp>)/span>span classn>regRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>register_user/span>span classp>(/span>span classn>nonce/span>span classo>/span>span classn>nonceRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>nonce/span>span classp>,/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key_y_coordinate/span>span classp>,/span>span classn>ethereum_address/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>key/span> span classo>/span> span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>key/span>span classp>/span>span classn>secret/span> span classo>/span> span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>secret/span>span classp>/span>span classn>passphrase/span> span classo>/span> span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>passphrase/span>span classp>/span>span classc1>#back stark_key_pair, apiKey,and accountId for private Api or create-oreder or withdraw/span>span classk>print/span>span classp>(/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>account/span>span classp>/span>span classs>positionId/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>)/span>/code>/pre>/div>ul>li>p>Signature content message includes timeStamp + method + path + dataStringbr>code>message timeStamp + method + path + dataString/code> /p>/li>li>p>Get Requests: dataString content is not required, append query parameters in the pathcode>message timeStamp + method + path/code>/p>/li>li>p>Post Requests: Request body is saved in dataString content. To ensure proper sorting for parameters within the request body, parameters will be sorted by alphabetical order, refer to python sdk /p>/li>/ul>blockquote>p>Sign request message by apiSecret/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>def signspan classo>(/span> self, request_path, method, iso_timestamp, data,span classo>)/span>: span classnv>sortedItems/span>span classo>/span>sortedspan classo>(/span>data.itemsspan classo>()/span>,keyspan classo>/span>lambda x:x0,reversespan classo>/span>Falsespan classo>)/span> dataString span classo>/span> span classs1>&/span>.joinspan classo>(/span>span classs1>{key}{value}/span>.formatspan classo>(/span> span classnv>key/span>span classo>/span>x0, span classnv>value/span>span classo>/span>x1span classo>)/span> span classk>for /span>x span classk>in /span>sortedItems span classk>if /span>x1 is not Nonespan classo>)/span> message_string span classo>/span> span classo>(/span> iso_timestamp + method + request_path + dataString span classo>)/span> hashed span classo>/span> hmac.newspan classo>(/span> base64.standard_b64encodespan classo>(/span> span classo>(/span>self.api_key_credentialsspan classs1>secret/span>span classo>)/span>.encodespan classo>(/span>span classnv>encoding/span>span classo>/span>span classs1>utf-8/span>span classo>)/span>, span classo>)/span>, span classnv>msg/span>span classo>/span>message_string.encodespan classo>(/span>span classnv>encoding/span>span classo>/span>span classs1>utf-8/span>span classo>)/span>, span classnv>digestmod/span>span classo>/span>hashlib.sha256, span classo>)/span> span classk>return /span>base64.standard_b64encodespan classo>(/span>hashed.digestspan classo>())/span>.decodespan classo>()/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>sign/span>span classp>(/span> span classbp>self/span>span classp>,/span> span classn>request_path/span>span classp>,/span> span classn>method/span>span classp>,/span> span classn>iso_timestamp/span>span classp>,/span> span classn>data/span>span classp>,/span>span classp>):/span> span classn>sortedItems/span>span classo>/span>span classnb>sorted/span>span classp>(/span>span classn>data/span>span classp>./span>span classn>items/span>span classp>(),/span>span classn>key/span>span classo>/span>span classk>lambda/span> span classn>x/span>span classp>:/span>span classn>x/span>span classp>/span>span classmi>0/span>span classp>,/span>span classn>reverse/span>span classo>/span>span classbp>False/span>span classp>)/span> span classn>dataString/span> span classo>/span> span classs>&/span>span classp>./span>span classn>join/span>span classp>(/span>span classs>{key}{value}/span>span classp>./span>span classnb>format/span>span classp>(/span> span classn>key/span>span classo>/span>span classn>x/span>span classp>/span>span classmi>0/span>span classp>,/span> span classn>value/span>span classo>/span>span classn>x/span>span classp>/span>span classmi>1/span>span classp>)/span> span classk>for/span> span classn>x/span> span classow>in/span> span classn>sortedItems/span> span classk>if/span> span classn>x/span>span classp>/span>span classmi>1/span>span classp>/span> span classow>is/span> span classow>not/span> span classbp>None/span>span classp>)/span> span classn>message_string/span> span classo>/span> span classp>(/span> span classn>iso_timestamp/span> span classo>+/span> span classn>method/span> span classo>+/span> span classn>request_path/span> span classo>+/span> span classn>dataString/span> span classp>)/span> span classn>hashed/span> span classo>/span> span classn>hmac/span>span classp>./span>span classn>new/span>span classp>(/span> span classn>base64/span>span classp>./span>span classn>standard_b64encode/span>span classp>(/span> span classp>(/span>span classbp>self/span>span classp>./span>span classn>api_key_credentials/span>span classp>/span>span classs>secret/span>span classp>)./span>span classn>encode/span>span classp>(/span>span classn>encoding/span>span classo>/span>span classs>utf-8/span>span classp>),/span> span classp>),/span> span classn>msg/span>span classo>/span>span classn>message_string/span>span classp>./span>span classn>encode/span>span classp>(/span>span classn>encoding/span>span classo>/span>span classs>utf-8/span>span classp>),/span> span classn>digestmod/span>span classo>/span>span classn>hashlib/span>span classp>./span>span classn>sha256/span>span classp>,/span> span classp>)/span> span classk>return/span> span classn>base64/span>span classp>./span>span classn>standard_b64encode/span>span classp>(/span>span classn>hashed/span>span classp>./span>span classn>digest/span>span classp>())./span>span classn>decode/span>span classp>()/span>/code>/pre>/div>ul>li>Place signature content, apiKey and related information in the request header/li>/ul>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>signstr/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>request timeStamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>passphrase/td>/tr>/tbody>/table>h2 idgeneral-2-starkkey-signature>2. StarkKey Signature/h2>ul>li>For orders and withdrawals, two signatures are required: apiKey and starkKey./li>li>Users can obtain and save their public and private starkKey via wallet signature verification on ApeX Pro desktop or app/li>li>API trading users with Ethereum private keys can utilize python-sdk to generate the private and public key pair for starkKey and save them for future API requestsbr>/li>li>Refer to the a href/#starkkey-signature>starkkey Signature/a>/li>/ul>h2 idgeneral-response-parameters>Response Parameters/h2>ul>li>Application data can be found in "data"./li>li>If request fails, response parameters are as follows: ul>li>code>code/code> : Code errorbr>/li>li>code>msg/code> : Message error /li>li>code>key/code> : Keyword error, corresponding multi-language prompt Key will be selected based on keywords a href/#errors>Key/a>br>/li>li>code>detail/code> : Parameter data error used to supplement error prompts/li>/ul>/li>/ul>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classmi>10002/span>span classp>,/span>span classw> /span>span classnl>msg/span>span classp>:/span>span classw> /span>span classs2>has been expired!/span>span classp>,/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>time/span>span classp>:/span>span classw> /span>span classmi>1649409187477/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classs2>ORDER_NOT_CANCEL_FILLED/span>span classp>,/span>span classw> /span>span classnl>detail/span>span classp>:{/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classs2>1234556/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw> /span>/code>/pre>/div>h2 idgeneral-client_id-and-nonce-generation>Client_id and Nonce Generation/h2>p>When creating order and withdrawal requests, you will need to send a unique and randomly generated client_Id to server. You can refer to python codes:/p>div classhighlight>pre classhighlight shell tab-shell>code>def random_client_idspan classo>()/span>: span classk>return /span>strspan classo>(/span>intspan classo>(/span>floatspan classo>(/span>strspan classo>(/span>random.randomspan classo>())/span>2:span classo>)))/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>random_client_id/span>span classp>():/span> span classk>return/span> span classnb>str/span>span classp>(/span>span classnb>int/span>span classp>(/span>span classnb>float/span>span classp>(/span>span classnb>str/span>span classp>(/span>span classn>random/span>span classp>./span>span classn>random/span>span classp>())/span>span classmi>2/span>span classp>:)))/span>/code>/pre>/div>p>When utilizing starkKey signatures in creating order and withdrawal requests, you will need to change client_Id to nonce in the server. Refer to python codes for the algorithm:/p>div classhighlight>pre classhighlight shell tab-shell>code>def nonce_from_client_idspan classo>(/span>client_idspan classo>)/span>: message span classo>/span> hashlib.sha256span classo>()/span> message.updatespan classo>(/span>client_id.encodespan classo>())/span> span classc># Encode as UTF-8./span> span classk>return /span>intspan classo>(/span>message.digestspan classo>()/span>.hexspan classo>()/span>0:8, 16span classo>)/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>nonce_from_client_id/span>span classp>(/span>span classn>client_id/span>span classp>):/span> span classs>Generate a nonce deterministically from an arbitrary string./span> span classn>message/span> span classo>/span> span classn>hashlib/span>span classp>./span>span classn>sha256/span>span classp>()/span> span classn>message/span>span classp>./span>span classn>update/span>span classp>(/span>span classn>client_id/span>span classp>./span>span classn>encode/span>span classp>())/span> span classc1># Encode as UTF-8./span> span classk>return/span> span classnb>int/span>span classp>(/span>span classn>message/span>span classp>./span>span classn>digest/span>span classp>()./span>span classnb>hex/span>span classp>()/span>span classmi>0/span>span classp>:/span>span classmi>8/span>span classp>,/span> span classmi>16/span>span classp>)/span>/code>/pre>/div>h2 idgeneral-rate-limits>Rate Limits/h2>h3 idgeneral-rate-limits-ip-rate-limit>IP Rate Limit/h3>p>If you receive a HTTP 403 (Access Denied) response, your IP has been either temporarily or permanently banned. You should immediately review the below guidelines to ensure that your application does not continue to violate the limit. /p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>Limit 600 requests per 60 secs/td>td>Per IP/td>/tr>/tbody>/table>h3 idgeneral-rate-limits-api-rate-limit>API Rate Limit/h3>p>Rate Limits for All Private Endpoints Per Account/p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>80 requests per 60 secs/td>td>POST request/td>/tr>tr>td>600 requests per 60 secs/td>td>GET request/td>/tr>/tbody>/table>h3 idgeneral-rate-limits-orders-limit>Orders Limit/h3>p>Rate Limits for Creating Orders/p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>200 orders/td>td>Per user/td>/tr>/tbody>/table>h2 idgeneral-margin>Margin/h2>ul>li>On ApeX Pro, USDC is the default settleCurrency for all available contracts on the platform. The tick size for USDC is set by default to 6 decimal points./li>li>Every contract will have an initialMarginRate and maintenanceMarginRate./li>li>initialMarginRate (IMR): The margin required to open a position and is based on the position size and leverage./li>li>maintenanceMarginRate (MMR): The minimum amount required for holding a leveraged position/li>/ul>p>Margin required for each single position: /p>p>p stylebackground: #D5D5D5;padding: 16px 28px;>initialMargin abs（Size * Oracle Price* initialMarginRate）br/>maintenanceMargin abs（Size * Oracle Price* maintenanceMarginRate）/p>/p>p>Margin required by all positions under all contract types under your account:/p>p stylebackground: #D5D5D5;padding: 16px 28px;>total initialMargin Σ abs（Size * Oracle Price* initialMarginRate） br/>total maintenanceMargin Σ abs（Size * Oracle Price* maintenanceMarginRate）br/>br/>TotalAccountValue Q+Σ abs（Size*Oracle Price）/p>p>where Q is the USDC balance in your account./p>h3 idgeneral-margin-liquidation>Liquidation/h3>p>When the net equity of the account falls below the maintenance margin required, your position will be taken over by the liquidation engine and liquidated./p>h3 idgeneral-margin-deleverage>Deleverage/h3>h3 idgeneral-margin-funding-fee>Funding Fee/h3>p>Funding fees will be exchanged between long and short position holders every 1 hour.br>Please note that the funding rate will fluctuate in real time every 1 hour. If the funding rate is positive upon settlement, long position holders will pay the funding fees to short position holders. Similarly, when the funding rate is negative, short positive holders will pay long position holders.br>p stylebackground: #D5D5D5;padding: 16px 28px;>Funding Fees Position Value * Index Price * Funding Rate /p>/p>h2 idgeneral-oracle-price>Oracle Price/h2>p>ApeX Pro utilizes Oracle Price in the following case(s):/p>ul>li>User Balance/li>li>Liquidation Price/li>/ul>p>ApeX Pro pulls Oracle Price data from Stork, which is an oracle solution native to StarkNet and StarkEx. Stork will provide the price datapoint for ApeX Pro to determine the Liquidation Price./p>h2 idgeneral-index-price>Index Price/h2>p>ApeX Pro utilizes Index Price in the following case(s):- Profits and Losses- Funding Fees/p>p>Index Price is the sum of prices pulled from multiple crypto spot exchanges, then calculated based on weighted average. It is also used to derive funding fees.br>If the exchange's settlement token is not in USDC, e.g. In BTC-USDT, the exchange rate between USDC and USDT will be calculated as well. /p>ul>li>BTC-USDC/li>/ul>table>thead>tr>th>exchange/th>th>symbol/th>th>weight/th>/tr>/thead>tbody>tr>td>Binance/td>td>BTC-USDT/td>td>1/6/td>/tr>tr>td>CoinbasePro/td>td>BTC-USD/td>td>1/6/td>/tr>tr>td>FTX/td>td>BTC-USD/td>td>1/6/td>/tr>tr>td>OKEX/td>td>BTC-USDT/td>td>1/6/td>/tr>tr>td>Gemini/td>td>BTC-USD/td>td>1/6/td>/tr>tr>td>Kraken/td>td>BTC-USD/td>td>1/6/td>/tr>/tbody>/table>ul>li>ETH-USDC/li>/ul>table>thead>tr>th>exchange/th>th>symbol/th>th>weight/th>/tr>/thead>tbody>tr>td>Binance/td>td>ETH-USDT/td>td>1/6/td>/tr>tr>td>CoinbasePro/td>td>ETH-USD/td>td>1/6/td>/tr>tr>td>FTX/td>td>ETH-USD/td>td>1/6/td>/tr>tr>td>OKEX/td>td>ETH-USDT/td>td>1/6/td>/tr>tr>td>Gemini/td>td>ETH-USD/td>td>1/6/td>/tr>tr>td>Kraken/td>td>ETH-USD/td>td>1/6/td>/tr>/tbody>/table>h3 idgeneral-index-price-symbols-configs>Symbols Configs/h3>ul>li>BTC-USDC/li>/ul>table>thead>tr>th>name/th>th>value/th>/tr>/thead>tbody>tr>td>Min ticker price/td>td>0.5/td>/tr>tr>td>Min step size/td>td>0.001/td>/tr>tr>td>Min Order size/td>td>0.001/td>/tr>tr>td>Max Order size/td>td>100/td>/tr>tr>td>Max Position size/td>td>500/td>/tr>tr>td>InitialMarginRate/td>td>0.05/td>/tr>tr>td>MaintenanceMarginRate/td>td>0.03/td>/tr>tr>td>Baseline position value/td>td>1000000/td>/tr>tr>td>incrementalPositionValue/td>td>1000000/td>/tr>tr>td>incrementalInitialMarginRate/td>td>0.0075/td>/tr>tr>td>fundingInterestRate/td>td>0.0003/td>/tr>tr>td>Max fundingInterestRate/td>td>0.00046875，-0.00046875/td>/tr>/tbody>/table>ul>li>ETH-USDC/li>/ul>table>thead>tr>th>name/th>th>value/th>/tr>/thead>tbody>tr>td>Min ticker price/td>td>0.05/td>/tr>tr>td>Min step size/td>td>0.01/td>/tr>tr>td>Min Order size/td>td>0.01/td>/tr>tr>td>Max Order size/td>td>1000/td>/tr>tr>td>Max Position size/td>td>10000/td>/tr>tr>td>InitialMarginRate/td>td>0.05/td>/tr>tr>td>MaintenanceMarginRate/td>td>0.03/td>/tr>tr>td>Baseline position value/td>td>1000000/td>/tr>tr>td>incrementalPositionValue/td>td>1000000/td>/tr>tr>td>incrementalInitialMarginRate/td>td>0.0075/td>/tr>tr>td>fundingInterestRate/td>td>0.0003/td>/tr>tr>td>Max fundingInterestRate/td>td>0.00046875，-0.00046875/td>/tr>/tbody>/table>h1 idgeneral-v3-for-omni>General V3 for Omni/h1>p>v3.0.0 /p>h2 idgeneral-v3-for-omni-api-resources-and-support-channels>API Resources and Support Channels/h2>ul>li>a hrefhttps://pro.apex.exchange/>Home/a> - Access and manage your trades./li>li>OpenApi-SDK for v3/li>li>- a hrefhttps://github.com/ApeX-Protocol/apexpro-openapi>OpenApi-Python-SDK/a> - Official OpenApi Python SDK/li>li>a hrefhttps://t.me/ApeXdex>Telegram/a> - Discussion Chat Group/li>li>a hrefhttps://www.apex.exchange/discord>Discord/a> - Official Discussion Discord Group/li>li>a hrefhttps://twitter.com/OfficialApeXdex>Twitter/a> - Official Twitter Channel/li>/ul>h2 idgeneral-v3-for-omni-rest-base-endpoint>REST Base Endpoint:/h2>h3 idgeneral-v3-for-omni-rest-base-endpoint-testnet>Testnet:/h3>p>code>https://testnet.omni.apex.exchange/api//code>/p>h3 idgeneral-v3-for-omni-rest-base-endpoint-mainnet>Mainnet:/h3>p>code>https://omni.apex.exchange/api//code>/p>h2 idgeneral-v3-for-omni-testnet>Testnet/h2>ul>li>ApeX Omni's testnet can be found on code>https://testnet.omni.apex.exchange/code>, built on the BNB test chain or base sepolia test chain. /li>li>You can obtain assets for use on the testnet via the faucet here code>https://testnet.omni.apex.exchange/faucet/code>./li>li>ApeX Omni's USDT Token Address (BNB test chain): code>0x01CB59F3C16FAfe63955e4d435adAFa23d9aBBde/code>br>/li>li>ApeX Omni's USDT Token Address (base sepolia test chain): code>0x2340C88808dcE139B36864970074315BCb0c9Fe0/code>/li>/ul>h2 idgeneral-v3-for-omni-development>Development/h2>ul>li>code>apex omni/code> is being actively developed, and new API changes should arrive on code>apex omni/code> very quickly. code>apex omni/code> uses code>requests/code> and code>websocket/code> for its methods, alongside other built-in modules. Anyone is welcome to branch/fork the repository and add their own upgrades. If you think you've made substantial improvements to the module, submit a pull request and we'll gladly take a look./li>li>If the user's computer using arm chip, change (libzklink_sdk-arm.dylib and zklink_sdk-arm.py) to (libzklink_sdk.dylib, zklink_sdk.py) and replace old (libzklink_sdk.dylib and zklink_sdk.py) in the directory ./apexpro/ and ./test//li>li>If the user's computer using x86 chip, change (libzklink_sdk-x86.dylib and zklink_sdk-x86.py) to (libzklink_sdk.dylib, zklink_sdk.py) and replace old (libzklink_sdk.dylib and zklink_sdk.py) in the directory ./apexpro/ and ./test//li>li>If the user's computer OS is windows, copy zklink_sdk.dll in the directory ./apexpro/ and ./test/. Change zklink_sdk-pc.py to zklink_sdk.py and replace and zklink_sdk.py in the directory ./apexpro/ and ./test//li>li>If the user's computer OS is Linux and x86 chip, copy zklink_sdk.so in the directory ./apexpro/ and ./test/. Change zklink_sdk-pc.py to zklink_sdk.py and replace and zklink_sdk.py in the directory ./apexpro/ and ./test//li>/ul>h2 idgeneral-v3-for-omni-installation>Installation/h2>p>code>apex omni/code> requires Python 3.6.1 - Python 3.9.x . The module can be installed manually or via a hrefhttps://pypi.org/project/apexomni-arm/>apexomni-arm/a> or a hrefhttps://pypi.org/project/apexomni-x86-mac/>apexomni-x86-mac/a> or a hrefhttps://pypi.org/project/apexomni-x86-windows-linux/>apexomni-x86-windows-linux/a> with code>pip/code>: /p>ul>li>code>pip3 install apexomni-arm/code>br>/li>li>code>pip3 install apexomni-x86-mac/code>br>/li>li>code>pip3 install apexomni-x86-windows-linux/code>br>/li>/ul>h2 idgeneral-v3-for-omni-query-path-and-parameters>Query path and Parameters:/h2>ul>li>You must include ApeX Omni's version number in the url path, e.g. v3./li>li>The parameter "url path" is not case-sensitive and lower case letters will be displayed by default. The en-dash (-) can be used as spaces between individual words./li>li>The HTTP endpoint parameters are in camel case, opening with lower case letters./li>li>Due to different time zones with time parameters, please use int64 across all instances by default./li>li>Randomly generated id and numbers may be long in length and considering that the js display may be intercepted, these will be reflected as a string by default/li>li>For customized request headers, please enter key in upper case and use the en-dash (-) as spaces between individual words./li>/ul>h3 idgeneral-v3-for-omni-query-path-and-parameters-http-get-request>Http Get Request/h3>p>Please add parameters to the query path.asbr>code>https://omni.apex.exchange/api/v3/transfers?limit100&page1&currencyIdUSDC&chainIds1/code>/p>h3 idgeneral-v3-for-omni-query-path-and-parameters-http-post-request>Http Post Request/h3>p>Enter order data in body, in the content-type x-www-form-urlencoded. You do not need to encode your data. as code>l2Keyxxx&ethAddressyyy&chainIdzzz/code>/p>h2 idgeneral-v3-for-omni-public-api-endpoints-verification-required>Public API Endpoints (Verification Required)/h2>p>a href/#publicapi>publicApi/a>/p>h2 idgeneral-v3-for-omni-private-api-endpoints-authentication-required>Private API Endpoints (Authentication Required)/h2>p>a href/#privateapi>privateApi/a> /p>p>All requests made to private endpoints must be authenticated. The following signatures must be used for authentication:/p>h2 idgeneral-v3-for-omni-1-apikey-signature>1. ApiKey Signature/h2>ul>li>An apiKey signature is required for all private API endpoints/li>li>Users can obtain and save their public and private apiKey via wallet signature verification on ApeX Omni desktop or app/li>li>API trading users can utilize python-sdk to generate the private and public key pair for apiKey and save them for future API requests, refer to python sdkbr>/li>/ul>blockquote>p>Generate apiKey/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>from apexpro.constants import APEX_OMNI_HTTP_MAIN, NETWORKID_OMNI_MAIN_ARB, NETWORKID_MAINprintspan classo>(/span>span classs2>Hello, Apex Omni/span>span classo>)/span>priKey span classo>/span> span classs2>your eth private key/span>client span classo>/span> HttpPrivate_v3span classo>(/span>APEX_OMNI_HTTP_MAIN, span classnv>network_id/span>span classo>/span>NETWORKID_MAIN, span classnv>eth_private_key/span>span classo>/span>priKeyspan classo>)/span>configs span classo>/span> client.configs_v3span classo>()/span>zkKeys span classo>/span> client.derive_zk_keyspan classo>(/span>client.default_addressspan classo>)/span>printspan classo>(/span>zkKeysspan classo>)/span>printspan classo>(/span>zkKeysspan classs1>seeds/span>span classo>)/span>printspan classo>(/span>zkKeysspan classs1>l2Key/span>span classo>)/span>printspan classo>(/span>zkKeysspan classs1>pubKeyHash/span>span classo>)/span>nonceRes span classo>/span> client.generate_nonce_v3span classo>(/span>span classnv>refresh/span>span classo>/span>span classs2>false/span>, span classnv>l2Key/span>span classo>/span>zkKeysspan classs1>l2Key/span>span classo>/span>,ethAddressspan classo>/span>client.default_address, span classnv>chainId/span>span classo>/span>NETWORKID_OMNI_MAIN_ARBspan classo>)/span>regRes span classo>/span> client.register_user_v3span classo>(/span>span classnv>nonce/span>span classo>/span>nonceResspan classs1>data/span>span classo>/span>span classs1>nonce/span>span classo>/span>,l2Keyspan classo>/span>zkKeysspan classs1>l2Key/span>span classo>/span>, span classnv>seeds/span>span classo>/span>zkKeysspan classs1>seeds/span>span classo>/span>,ethereum_addressspan classo>/span>client.default_addressspan classo>)/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>key/span>span classo>)/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>secret/span>span classo>)/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>/span>span classs1>passphrase/span>span classo>)/span>time.sleepspan classo>(/span>10span classo>)/span>accountRes span classo>/span> client.get_account_v3span classo>()/span>printspan classo>(/span>accountResspan classo>)/span>span classc>#back zkKeys, apiKey,and accountId for private Api or create-order transfer or withdraw/span>printspan classo>(/span>regResspan classs1>data/span>span classo>/span>span classs1>apiKey/span>span classo>)/span>changeRes span classo>/span> client.change_pub_key_v3span classo>(/span>span classnv>chainId/span>span classo>/span>NETWORKID_OMNI_MAIN_ARB, span classnv>seeds/span>span classo>/span>zkKeys.getspan classo>(/span>span classs1>seeds/span>span classo>)/span>, span classnv>ethPrivateKey/span>span classo>/span>priKey, zkAccountId span classo>/span> accountRes.getspan classo>(/span>span classs1>spotAccount/span>span classo>)/span>.getspan classo>(/span>span classs1>zkAccountId/span>span classo>)/span>, subAccountId span classo>/span> accountRes.getspan classo>(/span>span classs1>spotAccount/span>span classo>)/span>.getspan classo>(/span>span classs1>defaultSubAccountId/span>span classo>)/span>, newPkHash span classo>/span> zkKeys.getspan classo>(/span>span classs1>pubKeyHash/span>span classo>)/span>, span classnv>nonce/span>span classo>/span> accountRes.getspan classo>(/span>span classs1>spotAccount/span>span classo>)/span>.getspan classo>(/span>span classs1>nonce/span>span classo>)/span>, span classnv>l2Key/span>span classo>/span> zkKeys.getspan classo>(/span>span classs1>l2Key/span>span classo>))/span>printspan classo>(/span>changeResspan classo>)/span>time.sleepspan classo>(/span>10span classo>)/span>accountRes span classo>/span> client.get_account_v3span classo>()/span>printspan classo>(/span>accountResspan classo>)/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classk>print/span>span classp>(/span>span classs>Hello, Apex Omni/span>span classp>)/span>span classn>priKey/span> span classo>/span> span classs>your eth private key/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classn>priKey/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>zkKeys/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_zk_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>/span>span classs>seeds/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>/span>span classs>pubKeyHash/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce_v3/span>span classp>(/span>span classn>refresh/span>span classo>/span>span classs>false/span>span classp>,/span> span classn>l2Key/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span> span classn>chainId/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>)/span>span classn>regRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>register_user_v3/span>span classp>(/span>span classn>nonce/span>span classo>/span>span classn>nonceRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>nonce/span>span classp>,/span>span classn>l2Key/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>,/span> span classn>seeds/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>seeds/span>span classp>,/span>span classn>ethereum_address/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>key/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>secret/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>/span>span classs>passphrase/span>span classp>)/span>span classn>time/span>span classp>./span>span classn>sleep/span>span classp>(/span>span classmi>10/span>span classp>)/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classk>print/span>span classp>(/span>span classn>accountRes/span>span classp>)/span>span classc1>#back zkKeys, apiKey,and accountId for private Api or create-order transfer or withdraw/span>span classk>print/span>span classp>(/span>span classn>regRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>apiKey/span>span classp>)/span>span classn>changeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>change_pub_key_v3/span>span classp>(/span>span classn>chainId/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>seeds/span>span classo>/span>span classn>zkKeys/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>seeds/span>span classp>),/span> span classn>ethPrivateKey/span>span classo>/span>span classn>priKey/span>span classp>,/span> span classn>zkAccountId/span> span classo>/span> span classn>accountRes/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>spotAccount/span>span classp>)./span>span classn>get/span>span classp>(/span>span classs>zkAccountId/span>span classp>),/span> span classn>subAccountId/span> span classo>/span> span classn>accountRes/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>spotAccount/span>span classp>)./span>span classn>get/span>span classp>(/span>span classs>defaultSubAccountId/span>span classp>),/span> span classn>newPkHash/span> span classo>/span> span classn>zkKeys/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>pubKeyHash/span>span classp>),/span> span classn>nonce/span>span classo>/span> span classn>accountRes/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>spotAccount/span>span classp>)./span>span classn>get/span>span classp>(/span>span classs>nonce/span>span classp>),/span> span classn>l2Key/span>span classo>/span> span classn>zkKeys/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>l2Key/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>changeRes/span>span classp>)/span>span classn>time/span>span classp>./span>span classn>sleep/span>span classp>(/span>span classmi>10/span>span classp>)/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classk>print/span>span classp>(/span>span classn>accountRes/span>span classp>)/span>/code>/pre>/div>ul>li>p>Signature content message includes timeStamp + method + path + dataStringbr>code>message timeStamp + method + path + dataString/code> /p>/li>li>p>Get Requests: dataString content is not required, append query parameters in the pathcode>message timeStamp + method + path/code>/p>/li>li>p>Post Requests: Request body is saved in dataString content. To ensure proper sorting for parameters within the request body, parameters will be sorted by alphabetical order, refer to python sdk /p>/li>/ul>blockquote>p>Sign request message by apiSecret/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>def signspan classo>(/span> self, request_path, method, iso_timestamp, data,span classo>)/span>: span classnv>sortedItems/span>span classo>/span>sortedspan classo>(/span>data.itemsspan classo>()/span>,keyspan classo>/span>lambda x:x0,reversespan classo>/span>Falsespan classo>)/span> dataString span classo>/span> span classs1>&/span>.joinspan classo>(/span>span classs1>{key}{value}/span>.formatspan classo>(/span> span classnv>key/span>span classo>/span>x0, span classnv>value/span>span classo>/span>x1span classo>)/span> span classk>for /span>x span classk>in /span>sortedItems span classk>if /span>x1 is not Nonespan classo>)/span> message_string span classo>/span> span classo>(/span> iso_timestamp + method + request_path + dataString span classo>)/span> hashed span classo>/span> hmac.newspan classo>(/span> base64.standard_b64encodespan classo>(/span> span classo>(/span>self.api_key_credentialsspan classs1>secret/span>span classo>)/span>.encodespan classo>(/span>span classnv>encoding/span>span classo>/span>span classs1>utf-8/span>span classo>)/span>, span classo>)/span>, span classnv>msg/span>span classo>/span>message_string.encodespan classo>(/span>span classnv>encoding/span>span classo>/span>span classs1>utf-8/span>span classo>)/span>, span classnv>digestmod/span>span classo>/span>hashlib.sha256, span classo>)/span> span classk>return /span>base64.standard_b64encodespan classo>(/span>hashed.digestspan classo>())/span>.decodespan classo>()/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>sign/span>span classp>(/span> span classbp>self/span>span classp>,/span> span classn>request_path/span>span classp>,/span> span classn>method/span>span classp>,/span> span classn>iso_timestamp/span>span classp>,/span> span classn>data/span>span classp>,/span>span classp>):/span> span classn>sortedItems/span>span classo>/span>span classnb>sorted/span>span classp>(/span>span classn>data/span>span classp>./span>span classn>items/span>span classp>(),/span>span classn>key/span>span classo>/span>span classk>lambda/span> span classn>x/span>span classp>:/span>span classn>x/span>span classp>/span>span classmi>0/span>span classp>,/span>span classn>reverse/span>span classo>/span>span classbp>False/span>span classp>)/span> span classn>dataString/span> span classo>/span> span classs>&/span>span classp>./span>span classn>join/span>span classp>(/span>span classs>{key}{value}/span>span classp>./span>span classnb>format/span>span classp>(/span> span classn>key/span>span classo>/span>span classn>x/span>span classp>/span>span classmi>0/span>span classp>,/span> span classn>value/span>span classo>/span>span classn>x/span>span classp>/span>span classmi>1/span>span classp>)/span> span classk>for/span> span classn>x/span> span classow>in/span> span classn>sortedItems/span> span classk>if/span> span classn>x/span>span classp>/span>span classmi>1/span>span classp>/span> span classow>is/span> span classow>not/span> span classbp>None/span>span classp>)/span> span classn>message_string/span> span classo>/span> span classp>(/span> span classn>iso_timestamp/span> span classo>+/span> span classn>method/span> span classo>+/span> span classn>request_path/span> span classo>+/span> span classn>dataString/span> span classp>)/span> span classn>hashed/span> span classo>/span> span classn>hmac/span>span classp>./span>span classn>new/span>span classp>(/span> span classn>base64/span>span classp>./span>span classn>standard_b64encode/span>span classp>(/span> span classp>(/span>span classbp>self/span>span classp>./span>span classn>api_key_credentials/span>span classp>/span>span classs>secret/span>span classp>)./span>span classn>encode/span>span classp>(/span>span classn>encoding/span>span classo>/span>span classs>utf-8/span>span classp>),/span> span classp>),/span> span classn>msg/span>span classo>/span>span classn>message_string/span>span classp>./span>span classn>encode/span>span classp>(/span>span classn>encoding/span>span classo>/span>span classs>utf-8/span>span classp>),/span> span classn>digestmod/span>span classo>/span>span classn>hashlib/span>span classp>./span>span classn>sha256/span>span classp>,/span> span classp>)/span> span classk>return/span> span classn>base64/span>span classp>./span>span classn>standard_b64encode/span>span classp>(/span>span classn>hashed/span>span classp>./span>span classn>digest/span>span classp>())./span>span classn>decode/span>span classp>()/span>/code>/pre>/div>ul>li>Place signature content, apiKey and related information in the request header/li>/ul>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>signstr/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>request timeStamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>passphrase/td>/tr>/tbody>/table>h2 idgeneral-v3-for-omni-2-zkkeys-signature>2. zkKeys Signature/h2>ul>li>For orders, transfers and withdrawals, two signatures are required: apiKey and zkKeys./li>li>Users can obtain and save their l2Key and seed zkKeys via wallet signature verification on ApeX Omni desktop or app/li>li>API trading users with Ethereum private keys can utilize python-sdk to generate the l2Key and seed for zkKeys and save them for future API requestsbr>/li>li>Refer to the a hrefhttps://github.com/zkLinkProtocol/zklink_sdk/blob/2263e88d5423a1adae8402dc1b62d234d2a446dd/README.md#L15>zkKeys Signature/a>/li>/ul>h2 idgeneral-v3-for-omni-client_id-and-nonce-generation>Client_id and Nonce Generation/h2>p>When creating order and withdrawal requests, you will need to send a unique and randomly generated client_Id to server. You can refer to python codes:/p>div classhighlight>pre classhighlight shell tab-shell>code>def random_client_idspan classo>()/span>: span classk>return /span>strspan classo>(/span>intspan classo>(/span>floatspan classo>(/span>strspan classo>(/span>random.randomspan classo>())/span>2:span classo>)))/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>random_client_id/span>span classp>():/span> span classk>return/span> span classnb>str/span>span classp>(/span>span classnb>int/span>span classp>(/span>span classnb>float/span>span classp>(/span>span classnb>str/span>span classp>(/span>span classn>random/span>span classp>./span>span classn>random/span>span classp>())/span>span classmi>2/span>span classp>:)))/span>/code>/pre>/div>p>When utilizing zkKeys signatures in creating order and withdrawal requests, you will need to change client_Id to nonce and slotId in the server. Refer to python codes for the algorithm:/p>div classhighlight>pre classhighlight shell tab-shell>code>message span classo>/span> hashlib.sha256span classo>()/span> message.updatespan classo>(/span>clientId.encodespan classo>())/span> span classc># Encode as UTF-8./span> nonceHash span classo>/span> message.hexdigestspan classo>()/span> nonceInt span classo>/span> intspan classo>(/span>nonceHash, 16span classo>)/span> maxUint32 span classo>/span> np.iinfospan classo>(/span>np.uint32span classo>)/span>.max maxUint64 span classo>/span> np.iinfospan classo>(/span>np.uint64span classo>)/span>.max slotId span classo>/span> span classo>(/span>nonceInt % maxUint64span classo>)/span>/maxUint32 nonce span classo>/span> nonceInt % maxUint32 accountId span classo>/span> intspan classo>(/span>accountId, 10span classo>)/span> % maxUint32/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>message/span> span classo>/span> span classn>hashlib/span>span classp>./span>span classn>sha256/span>span classp>()/span>span classn>message/span>span classp>./span>span classn>update/span>span classp>(/span>span classn>clientId/span>span classp>./span>span classn>encode/span>span classp>())/span> span classc1># Encode as UTF-8./span>span classn>nonceHash/span> span classo>/span> span classn>message/span>span classp>./span>span classn>hexdigest/span>span classp>()/span>span classn>nonceInt/span> span classo>/span> span classnb>int/span>span classp>(/span>span classn>nonceHash/span>span classp>,/span> span classmi>16/span>span classp>)/span>span classn>maxUint32/span> span classo>/span> span classn>np/span>span classp>./span>span classn>iinfo/span>span classp>(/span>span classn>np/span>span classp>./span>span classn>uint32/span>span classp>)./span>span classnb>max/span>span classn>maxUint64/span> span classo>/span> span classn>np/span>span classp>./span>span classn>iinfo/span>span classp>(/span>span classn>np/span>span classp>./span>span classn>uint64/span>span classp>)./span>span classnb>max/span>span classn>slotId/span> span classo>/span> span classp>(/span>span classn>nonceInt/span> span classo>%/span> span classn>maxUint64/span>span classp>)/span>span classo>//span>span classn>maxUint32/span>span classn>nonce/span> span classo>/span> span classn>nonceInt/span> span classo>%/span> span classn>maxUint32/span>span classn>accountId/span> span classo>/span> span classnb>int/span>span classp>(/span>span classn>accountId/span>span classp>,/span> span classmi>10/span>span classp>)/span> span classo>%/span> span classn>maxUint32/span>/code>/pre>/div>h2 idgeneral-v3-for-omni-spot-account>Spot Account/h2>p>Users can deposit USDT into Spot account, and in the future, deposits of BTC, ETH, BNB, USDC and other assets into Spot Account will be opened. /p>h2 idgeneral-v3-for-omni-contract-account>Contract Account/h2>h2 idgeneral-v3-for-omni-margin>Margin/h2>ul>li>On ApeX Omni, USDT is the default settleCurrency for all available contracts on the platform. The tick size for USDT is set by default to 6 decimal points./li>li>Every contract will have an initialMarginRate and maintenanceMarginRate./li>li>initialMarginRate (IMR): The margin required to open a position and is based on the position size and leverage./li>li>maintenanceMarginRate (MMR): The minimum amount required for holding a leveraged position/li>/ul>p>Margin required for each single position: /p>p>p stylebackground: #D5D5D5;padding: 16px 28px;>initialMargin abs（Size * Oracle Price* initialMarginRate）br/>maintenanceMargin abs（Size * Oracle Price* maintenanceMarginRate）/p>/p>p>Margin required by all positions under all contract types under your account:/p>p stylebackground: #D5D5D5;padding: 16px 28px;>total initialMargin Σ abs（Size * Oracle Price* initialMarginRate） br/>total maintenanceMargin Σ abs（Size * Oracle Price* maintenanceMarginRate）br/>br/>TotalAccountValue Q+Σ abs（Size*Oracle Price）/p>p>where Q is the USDT balance in your account./p>h3 idgeneral-v3-for-omni-margin-liquidation>Liquidation/h3>p>When the net equity of the account falls below the maintenance margin required, your position will be taken over by the liquidation engine and liquidated./p>h3 idgeneral-v3-for-omni-margin-funding-fee>Funding Fee/h3>p>Funding fees will be exchanged between long and short position holders every 1 hour.br>Please note that the funding rate will fluctuate in real time every 1 hour. If the funding rate is positive upon settlement, long position holders will pay the funding fees to short position holders. Similarly, when the funding rate is negative, short positive holders will pay long position holders.br>p stylebackground: #D5D5D5;padding: 16px 28px;>Funding Fees Position Value * Index Price * Funding Rate /p>/p>h2 idgeneral-v3-for-omni-index-price>Index Price/h2>p>ApeX Pro utilizes Index Price in the following case(s):- User Balance- Liquidation Price- Profits and Losses- Funding Fees/p>p>Index Price is the sum of prices pulled from multiple crypto spot exchanges, then calculated based on weighted average. It is also used to derive funding fees. /p>h2 idgeneral-v3-for-omni-rate-limits>Rate Limits/h2>h3 idgeneral-v3-for-omni-rate-limits-ip-rate-limit>IP Rate Limit/h3>p>If you receive a HTTP 403 (Access Denied) response, your IP has been either temporarily or permanently banned. You should immediately review the below guidelines to ensure that your application does not continue to violate the limit./p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>Limit 600 requests per 60 secs/td>td>Per IP/td>/tr>/tbody>/table>h3 idgeneral-v3-for-omni-rate-limits-api-rate-limit>API Rate Limit/h3>p>Rate Limits for All Private Endpoints Per Account/p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>80 requests per 60 secs/td>td>POST request/td>/tr>tr>td>600 requests per 60 secs/td>td>GET request/td>/tr>/tbody>/table>h3 idgeneral-v3-for-omni-rate-limits-orders-limit>Orders Limit/h3>p>Rate Limits for Creating Orders/p>table>thead>tr>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>200 orders/td>td>Per user/td>/tr>/tbody>/table>h1 idv2-or-v1>V2 or V1/h1>p>ApeX OpenAPI V2 now supports USDT currency pairs! Users can seamlessly manage USDT and USDC accounts, handle deposits and withdrawals, and meet all their currency pair trading needs through V2 APIs. Additionally, V2 adheres to the standards set by V1 for a consistent experience. /p>h2 idv2-or-v1-current-api-coverage>Current API Coverage/h2>table>thead>tr>th>OpenAPI/th>th>USDT Account/th>th>USDC Account/th>th>USDT Perp/th>th>USDC Perp/th>th>Quote/th>th>USDT Deposit/th>th>USDC Deposit/th>/tr>/thead>tbody>tr>td>V1/td>td>NO/td>td>YES/td>td>NO/td>td>YES/td>td>YES/td>td>NO/td>td>YES/td>/tr>tr>td>V2/td>td>YES/td>td>YES/td>td>YES/td>td>YES/td>td>YES/td>td>YES/td>td>YES/td>/tr>/tbody>/table>p>warningbr>Please note, the USDT account and USDC account are independent. Assets and positions are not shared, and deposits and withdrawals are processed separately.br>To start trading USDT perpetual contract currency pairs, it is necessary to request V2 a href/#privateapi_v2-post-registration-amp-onboarding-v2>onboarding/a> and register a USDT account. /p>h3 idv2-or-v1-current-api-coverage-sdk-v2>sdk-v2/h3>ol>li>The client initialization methods in v1 and v2 remain the same. For example:br>/li>/ol>div classhighlight>pre classhighlight plaintext>code>client HttpPrivate(APEX_HTTP_TEST, network_idNETWORKID_TEST, eth_private_keypriKey)/code>/pre>/div>div classhighlight>pre classhighlight plaintext>code>client HttpPublic(APEX_HTTP_MAIN)/code>/pre>/div>ol>li>If the method names in v1 and v2 are identical, it indicates that the implementation logic in v1 and v2 has not changed, and the path supports HTTP requests for both v1 and v2. For example:br>/li>/ol>div classhighlight>pre classhighlight plaintext>code>client HttpPublic(APEX_HTTP_MAIN) print(client.klines(symbolETHUSDT,interval5,start1681463600, end1681563600, limit5)) print(client.depth(symbolBTC-USDC)) /code>/pre>/div>ol>li>If the method names in v1 and v2 differ, it signifies a change in the implementation logic between v1 and v2, and the request paths also differ. Request methods are distinguished by v2 and v1. For example:br>/li>/ol>div classhighlight>pre classhighlight plaintext>code>client HttpPrivate(APEX_HTTP_TEST, network_idNETWORKID_TEST, api_key_credentials{key: key,secret: secret, passphrase: passphrase}) configs client.configs_v2() accountRes client.get_account_v2() print(accountRes) /code>/pre>/div>h1 idpublicapi-v3-for-omni>PublicApi V3 for Omni/h1>p>v3.0.0 /p>h2 idpublicapi-v3-for-omni-get-system-time-v3>GET System Time V3/h2>p>code>GET /v3/time/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>server_time/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/time/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>time/span>span classp>:/span>span classw> /span>span classmi>1648626529/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-system-time-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-system-time-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» time/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-all-config-data-v3>GET All Config Data V3/h2>p>USDC and USDT config/p>p>code>GET /v3/symbols/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/symbols/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>spotConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>assets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>17/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>USD Coin/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>35/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/BNB.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>36/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>Ethereum/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_ETH.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>140/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>Tether USD Coin/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>global/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>defaultRegisterTransferToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>defaultRegisterTransferTokenId/span>span classp>:/span>span classw> /span>span classs2>140/span>span classp>,/span>span classw> /span>span classnl>defaultRegisterSubAccountId/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>defaultChangePubKeyZklinkChainId/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>defaultChangePubKeyFeeTokenId/span>span classp>:/span>span classw> /span>span classs2>140/span>span classp>,/span>span classw> /span>span classnl>defaultChangePubKeyFeeToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>defaultChangePubKeyFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>registerTransferLpAccountId/span>span classp>:/span>span classw> /span>span classs2>577029250759000065/span>span classp>,/span>span classw> /span>span classnl>registerTransferLpSubAccount/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>registerTransferLpSubAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>0x2924686165271a5de8248833a8ab7a6f7fb7f950d7512ecd56952283cc434d8c/span>span classp>,/span>span classw> /span>span classnl>perpLpAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>perpLpSubAccount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>perpLpSubAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>contractAssetPoolAccountId/span>span classp>:/span>span classw> /span>span classs2>577390086971195406/span>span classp>,/span>span classw> /span>span classnl>contractAssetPoolZkAccountId/span>span classp>:/span>span classw> /span>span classs2>46/span>span classp>,/span>span classw> /span>span classnl>contractAssetPoolSubAccount/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>contractAssetPoolL2Key/span>span classp>:/span>span classw> /span>span classs2>0xa54a045e186e7e8635b1d444e14f59c86767c685bbfff92d6b7118113d845d2f/span>span classp>,/span>span classw> /span>span classnl>contractAssetPoolEthAddress/span>span classp>:/span>span classw> /span>span classs2>0xa50A3b5c5f6192742db99fA21d832ddd72D3028E/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>spot/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>multiChain/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chains/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>BNB Chain - Testnet/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>chainType/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>l1ChainId/span>span classp>:/span>span classw> /span>span classs2>97/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/chains/chain_tokens/BSC/BNB_BNB.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x20F48e49549163976f974E8983Bb451E5Dcf53fD/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>feeGasLimit/span>span classp>:/span>span classw> /span>span classmi>300000/span>span classp>,/span>span classw> /span>span classnl>blockTimeSeconds/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://data-seed-prebsc-2-s1.binance.org:8545/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://data-seed-prebsc-2-s1.binance.org:8545/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://testnet.bscscan.com/tx//span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x01cb59f3c16fafe63955e4d435adafa23d9abbde/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>200/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xf35a44977e9831f564c9af3b721748e840c1ef4c/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>200/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/BNB.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>0.00001/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>Base Sepolia Chain - Testnet/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>11/span>span classp>,/span>span classw> /span>span classnl>chainType/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>l1ChainId/span>span classp>:/span>span classw> /span>span classs2>84532/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/chains/chain_logos/base.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x8cDdB93BD8845aE509a6eC1e29836852A9b41b10/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>feeGasLimit/span>span classp>:/span>span classw> /span>span classmi>300000/span>span classp>,/span>span classw> /span>span classnl>blockTimeSeconds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://sepolia.base.org/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://sepolia.base.org/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://sepolia.basescan.org/tx//span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x2340c88808dce139b36864970074315bcb0c9fe0/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>200/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xaf3a3fd0eea662dd1aefa8b04c201038a4ff5761/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>200/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/ETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>needResetApproval/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>0.00001/span>span classp>,/span>span classw> /span>span classnl>maxFee/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>maxWithdraw/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>minDeposit/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>minWithdraw/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>contractConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>assets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>60017/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>USD Coin/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>60035/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/BNB.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>60036/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>Ethereum/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_ETH.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>60140/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>displayName/span>span classp>:/span>span classw> /span>span classs2>Tether USD Coin/span>span classp>,/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>l2WithdrawFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BTC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>EIGEN/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/EIGEN.svg/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>global/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>feeAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>feeAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>contractAssetLpAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>contractAssetLpL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>operationAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>operationL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>agentAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>agentL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>finxFeeAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>finxFeeL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>negativeRateAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>negativeRateL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>brokerAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>brokerL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>perpetualContract/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>30002/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.1,0.2,0.4,1,2/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>6/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00250/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00100/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.005/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.0010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.025/span>span classp>,/span>span classw> /span>span classnl>settleAssetId/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>baseTokenId/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.5000/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classw> /span>span classs2>5000000.0000/span>span classp>,/span>span classw> /span>span classnl>tagIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/LABLE_HOT.svg/span>span classp>,/span>span classw> /span>span classnl>tag/span>span classp>:/span>span classw> /span>span classs2>HOT/span>span classp>,/span>span classw> /span>span classnl>riskTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classnl>klineStartTime/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>maxMarketSizeBuffer/span>span classp>:/span>span classw> /span>span classs2>0.98/span>span classp>,/span>span classw> /span>span classnl>enableFundingSettlement/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>indexPriceDecimals/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classnl>indexPriceVarRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>openPositionOiLimitRate/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classnl>fundingMaxRate/span>span classp>:/span>span classw> /span>span classs2>0.000234/span>span classp>,/span>span classw> /span>span classnl>fundingMinRate/span>span classp>:/span>span classw> /span>span classs2>-0.000234/span>span classp>,/span>span classw> /span>span classnl>fundingMaxValue/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>enableFundingMxValue/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>l2PairId/span>span classp>:/span>span classw> /span>span classs2>50001/span>span classp>,/span>span classw> /span>span classnl>settleTimeStamp/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>isPrelaunch/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>riskLimitConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>positionSteps/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classs2>50000/span>span classp>,/span>span classw> /span>span classs2>100000/span>span classp>,/span>span classw> /span>span classs2>200000/span>span classp>,/span>span classw> /span>span classs2>300000/span>span classp>,/span>span classw> /span>span classs2>500000/span>span classp>,/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classs2>2000000/span>span classp>,/span>span classw> /span>span classs2>3000000/span>span classp>,/span>span classw> /span>span classs2>4000000/span>span classp>,/span>span classw> /span>span classs2>5000000/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>imrSteps/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classs2>0.01333/span>span classp>,/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>0.04/span>span classp>,/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classs2>0.2/span>span classp>,/span>span classw> /span>span classs2>0.25/span>span classp>,/span>span classw> /span>span classs2>0.33333/span>span classp>,/span>span classw> /span>span classs2>0.5/span>span classp>,/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>mmrSteps/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>0.005/span>span classp>,/span>span classw> /span>span classs2>0.0065/span>span classp>,/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>0.025/span>span classp>,/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classs2>0.125/span>span classp>,/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>0.25/span>span classp>,/span>span classw> /span>span classs2>0.5/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>prelaunchContract/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>EIGENUSDT/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.5,1,2,5,10/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>30/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>60/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00250/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00100/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>200000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.03333/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00700/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.0010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.025/span>span classp>,/span>span classw> /span>span classnl>settleAssetId/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>baseTokenId/span>span classp>:/span>span classw> /span>span classs2>EIGEN/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>EIGEN-USDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>EIGENUSDT/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.5/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.03000/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classw> /span>span classs2>10050000.0000/span>span classp>,/span>span classw> /span>span classnl>tagIconUrl/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>tag/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>riskTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultLeverage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>klineStartTime/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>maxMarketSizeBuffer/span>span classp>:/span>span classw> /span>span classs2>0.98/span>span classp>,/span>span classw> /span>span classnl>enableFundingSettlement/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>indexPriceDecimals/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classnl>indexPriceVarRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>openPositionOiLimitRate/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classnl>fundingMaxRate/span>span classp>:/span>span classw> /span>span classs2>0.000234/span>span classp>,/span>span classw> /span>span classnl>fundingMinRate/span>span classp>:/span>span classw> /span>span classs2>-0.000234/span>span classp>,/span>span classw> /span>span classnl>fundingMaxValue/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>enableFundingMxValue/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>l2PairId/span>span classp>:/span>span classw> /span>span classs2>60001/span>span classp>,/span>span classw> /span>span classnl>settleTimeStamp/span>span classp>:/span>span classw> /span>span classmi>1000000/span>span classp>,/span>span classw> /span>span classnl>isPrelaunch/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>riskLimitConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>positionSteps/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>imrSteps/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>mmrSteps/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>maxMarketBalanceBuffer/span>span classp>:/span>span classw> /span>span classs2>0.98/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-all-config-data-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-all-config-data-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» spotConfig/td>td>object/td>td>true/td>td>none/td>td>Spot trade config/td>/tr>tr>td>»» assets/td>td>object/td>td>true/td>td>none/td>td>Spot trade assets/td>/tr>tr>td>»»» tokenId/td>td>string/td>td>true/td>td>none/td>td>ZK token ID/td>/tr>tr>td>»»» token/td>td>string/td>td>true/td>td>none/td>td>ZK token name/td>/tr>tr>td>»»» displayName/td>td>string/td>td>true/td>td>none/td>td>ZK token displayName/td>/tr>tr>td>»»» decimals/td>td>integer/td>td>true/td>td>none/td>td>Contract token decimal point accuracy/td>/tr>tr>td>»»» showStep/td>td>string/td>td>true/td>td>none/td>td>Token show decimals/td>/tr>tr>td>»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Token icon url/td>/tr>tr>td>»»» l2WithdrawFee/td>td>string/td>td>true/td>td>none/td>td>Token withdraw fee/td>/tr>tr>td>»» global/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» defaultRegisterTransferToken/td>td>string/td>td>true/td>td>none/td>td>Default transfer token, as 'USDT'/td>/tr>tr>td>»»» defaultRegisterTransferTokenId/td>td>string/td>td>true/td>td>none/td>td>Default transfer zk token ID, as '141'/td>/tr>tr>td>»»» defaultRegisterSubAccountId/td>td>string/td>td>true/td>td>none/td>td>Default transfer zk sub account ID, as '0'/td>/tr>tr>td>»»» defaultChangePubKeyZklinkChainId/td>td>string/td>td>true/td>td>none/td>td>Default transfer zk chain ID, as '9'/td>/tr>tr>td>»»» defaultChangePubKeyFeeTokenId/td>td>string/td>td>true/td>td>none/td>td>Default change pub key fee token ID, as '141'/td>/tr>tr>td>»»» defaultChangePubKeyFeeToken/td>td>string/td>td>true/td>td>none/td>td>Default change pub key fee token, as 'USDT'/td>/tr>tr>td>»»» defaultChangePubKeyFee/td>td>string/td>td>true/td>td>none/td>td>Default change pub key fee, as '0'/td>/tr>tr>td>»»» registerTransferLpAccountId/td>td>string/td>td>true/td>td>none/td>td>transfer Lp account ID/td>/tr>tr>td>»»» registerTransferLpSubAccount/td>td>string/td>td>true/td>td>none/td>td>transfer Lp sub account ID/td>/tr>tr>td>»»» registerTransferLpSubAccountL2Key/td>td>string/td>td>true/td>td>none/td>td>transfer Lp account l2Key/td>/tr>tr>td>»»» perpLpAccountId/td>td>string/td>td>true/td>td>none/td>td>Perp Lp account ID/td>/tr>tr>td>»»» perpLpSubAccount/td>td>string/td>td>true/td>td>none/td>td>Perp Lp sub account ID/td>/tr>tr>td>»»» perpLpSubAccountL2Key/td>td>string/td>td>true/td>td>none/td>td>Perp Lp account l2Key/td>/tr>tr>td>»»» contractAssetPoolAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract asset pool account ID/td>/tr>tr>td>»»» contractAssetPoolZkAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract asset pool zk account ID/td>/tr>tr>td>»»» contractAssetPoolSubAccount/td>td>string/td>td>true/td>td>none/td>td>Contract asset pool sub account ID/td>/tr>tr>td>»»» contractAssetPoolL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract asset pool account l2Key/td>/tr>tr>td>»»» contractAssetPoolEthAddress/td>td>string/td>td>true/td>td>none/td>td>Contract asset pool eth address/td>/tr>tr>td>»» spot/td>td>string/td>td>true/td>td>none/td>td>Spot symbols/td>/tr>tr>td>»» multiChain/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»» maxWithdraw/td>td>string/td>td>true/td>td>none/td>td>Maximum withdrawal amount/td>/tr>tr>td>»»» minWithdraw/td>td>string/td>td>true/td>td>none/td>td>Minimum withdrawal amount/td>/tr>tr>td>»»» minDeposit/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit amount/td>/tr>tr>td>»»» currency/td>td>string/td>td>true/td>td>USDC/td>td>Currency/td>/tr>tr>td>»»» chains/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»»» chain/td>td>string/td>td>true/td>td>none/td>td>Chain/td>/tr>tr>td>»»»» contractAddress/td>td>string/td>td>true/td>td>none/td>td>Contract address/td>/tr>tr>td>»»»» chainIconUrl/td>td>string/td>td>true/td>td>none/td>td>Chain icon url/td>/tr>tr>td>»»»» gasToken/td>td>string/td>td>true/td>td>none/td>td>Gas token name/td>/tr>tr>td>»»»» rpcUrl/td>td>string/td>td>true/td>td>none/td>td>Chain RPC service Url/td>/tr>tr>td>»»»» chainId/td>td>integer/td>td>true/td>td>none/td>td>Chain ID/td>/tr>tr>td>»»»» feeLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable trading fees/td>/tr>tr>td>»»»» depositGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable deposit gas fees/td>/tr>tr>td>»»»» withdrawGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable withdraw gas fees/td>/tr>tr>td>»»»» minFee/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit gas fee: If gas+value*fee_rate is lesser than min_fee, min_fee amount will be charged instead/td>/tr>tr>td>»»»» feeRate/td>td>string/td>td>true/td>td>none/td>td>Fee rate/td>/tr>tr>td>»»»» webTxUrl/td>td>string/td>td>true/td>td>none/td>td>Transaction tx URL/td>/tr>tr>td>»»»» tokens/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»»»» token/td>td>string/td>td>true/td>td>none/td>td>Token name/td>/tr>tr>td>»»»»» tokenAddress/td>td>string/td>td>true/td>td>none/td>td>Token address/td>/tr>tr>td>»»»»» decimals/td>td>integer/td>td>true/td>td>none/td>td>Token decimal point accuracy/td>/tr>tr>td>»»»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Token icon URL/td>/tr>tr>td>»»»»» pullOff/td>td>bool/td>td>true/td>td>none/td>td>Enable taking down of listing, default as FALSE/td>/tr>tr>td>»»»» gasLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable gas free transaction/td>/tr>tr>td>»»»»» withdrawEnable/td>td>boolean/td>td>true/td>td>none/td>td>Enable withdraw/td>/tr>tr>td>»»»»» slippage/td>td>string/td>td>true/td>td>none/td>td>Swap slippage/td>/tr>tr>td>»»»»» isDefaultToken/td>td>boolean/td>td>true/td>td>none/td>td>If it is default token/td>/tr>tr>td>»»»»» displayToken/td>td>string/td>td>true/td>td>none/td>td>Display token name/td>/tr>tr>td>»»»»» needResetApproval/td>td>boolean/td>td>true/td>td>none/td>td>If it is need to reset approval/td>/tr>tr>td>»»»»» maxFee/td>td>string/td>td>true/td>td>none/td>td>Max deposit gas fee/td>/tr>tr>td>» contractConfig/td>td>object/td>td>true/td>td>none/td>td>Contract trade Config/td>/tr>tr>td>»» assets/td>td>object/td>td>true/td>td>none/td>td>Contract trade assets/td>/tr>tr>td>»»» tokenId/td>td>string/td>td>true/td>td>none/td>td>ZK token ID/td>/tr>tr>td>»»» token/td>td>string/td>td>true/td>td>none/td>td>ZK token name/td>/tr>tr>td>»»» displayName/td>td>string/td>td>true/td>td>none/td>td>ZK token displayName/td>/tr>tr>td>»»» decimals/td>td>integer/td>td>true/td>td>none/td>td>Contract token decimal point accuracy/td>/tr>tr>td>»»» showStep/td>td>string/td>td>true/td>td>none/td>td>Token show decimals/td>/tr>tr>td>»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Token icon url/td>/tr>tr>td>»»» l2WithdrawFee/td>td>string/td>td>true/td>td>none/td>td>Token withdraw fee/td>/tr>tr>td>»» tokens/td>td>object/td>td>true/td>td>none/td>td>Contract trade tokens/td>/tr>tr>td>»»» token/td>td>string/td>td>true/td>td>none/td>td>Contract trade token name/td>/tr>tr>td>»»» stepSize/td>td>string/td>td>true/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Contract trade token icon URL/td>/tr>tr>td>»» global/td>td>object/td>td>true/td>td>none/td>td>Contract trade global config/td>/tr>tr>td>»»» feeAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract fee account ID/td>/tr>tr>td>»»» feeAccountL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract fee account L2Key/td>/tr>tr>td>»»» contractAssetLpAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract asset Lp account ID/td>/tr>tr>td>»»» contractAssetLpL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract asset Lp account l2Key/td>/tr>tr>td>»»» operationAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract operation account ID/td>/tr>tr>td>»»» operationL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract operation account l2Key/td>/tr>tr>td>»»» experienceMoneyAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract experience money account ID/td>/tr>tr>td>»»» experienceMoneyL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract experience money l2Key/td>/tr>tr>td>»»» agentAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract agent account ID/td>/tr>tr>td>»»» agentL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract agent account l2Key/td>/tr>tr>td>»»» finxFeeAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract finx account ID/td>/tr>tr>td>»»» finxFeeL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract finx account l2Key/td>/tr>tr>td>»»» negativeRateAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract negative rate account ID/td>/tr>tr>td>»»» negativeRateL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract negative rate account l2Key/td>/tr>tr>td>»»» brokerAccountId/td>td>string/td>td>true/td>td>none/td>td>Contract broker account ID/td>/tr>tr>td>»»» brokerL2Key/td>td>string/td>td>true/td>td>none/td>td>Contract broker account l2Key/td>/tr>tr>td>»» prelaunchContract/td>td>object/td>td>true/td>td>none/td>td>Prelaunch contract symbols/td>/tr>tr>td>»» perpetualContract/td>td>object/td>td>true/td>td>none/td>td>Perpetual contract symbols/td>/tr>tr>td>»»» baselinePositionValue/td>td>string/td>td>false/td>td>none/td>td>Baseline position vaue/td>/tr>tr>td>»»» crossId/td>td>integer/td>td>false/td>td>none/td>td>Quote API use id for symbol/td>/tr>tr>td>»»» crossSymbolId/td>td>integer/td>td>false/td>td>none/td>td>Quote API use symbolId for symbol/td>/tr>tr>td>»»» crossSymbolName/td>td>string/td>td>false/td>td>none/td>td>Quote API use symbolName for symbol/td>/tr>tr>td>»»» digitMerge/td>td>string/td>td>false/td>td>none/td>td>Depth digit merge/td>/tr>tr>td>»»» displayMaxLeverage/td>td>string/td>td>false/td>td>none/td>td>Maximum leverage/td>/tr>tr>td>»»» displayMinLeverage/td>td>string/td>td>false/td>td>none/td>td>Minimum leverage/td>/tr>tr>td>»»» enableDisplay/td>td>boolean/td>td>false/td>td>none/td>td>Enable display/td>/tr>tr>td>»»» enableOpenPosition/td>td>boolean/td>td>false/td>td>none/td>td>Enable open position/td>/tr>tr>td>»»» enableTrade/td>td>boolean/td>td>false/td>td>none/td>td>Enable trade/td>/tr>tr>td>»»» fundingImpactMarginNotional/td>td>string/td>td>false/td>td>none/td>td>Not required on frontend/td>/tr>tr>td>»»» fundingInterestRate/td>td>string/td>td>false/td>td>none/td>td>Funding rate ratio/td>/tr>tr>td>»»» incrementalInitialMarginRate/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» incrementalMaintenanceMarginRate/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» incrementalPositionValue/td>td>string/td>td>false/td>td>none/td>td>Incremental position value/td>/tr>tr>td>»»» initialMarginRate/td>td>string/td>td>false/td>td>none/td>td>Incremental initial margin rate/td>/tr>tr>td>»»» maintenanceMarginRate/td>td>string/td>td>false/td>td>none/td>td>Incremental maintenance margin rate/td>/tr>tr>td>»»» maxOrderSize/td>td>string/td>td>false/td>td>none/td>td>Maximum order size/td>/tr>tr>td>»»» maxPositionSize/td>td>string/td>td>false/td>td>none/td>td>Maximum position size/td>/tr>tr>td>»»» minOrderSize/td>td>string/td>td>false/td>td>none/td>td>Minimum order size/td>/tr>tr>td>»»» maxMarketPriceRange/td>td>string/td>td>false/td>td>none/td>td>Maximum market price rangee/td>/tr>tr>td>»»» settleAssetId/td>td>string/td>td>false/td>td>none/td>td>Settlement asset id/td>/tr>tr>td>»»» baseTokenId/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» stepSize/td>td>string/td>td>false/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»»» symbol/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» symbolDisplayName/td>td>string/td>td>false/td>td>none/td>td>Symbol display name/td>/tr>tr>td>»»» tickSize/td>td>string/td>td>false/td>td>none/td>td>Minimum tick size/td>/tr>tr>td>»»» maxMaintenanceMarginRate/td>td>string/td>td>false/td>td>none/td>td>Maximum maintenance margin rate/td>/tr>tr>td>»»» maxPositionValue/td>td>string/td>td>false/td>td>none/td>td>Maximum position value/td>/tr>tr>td>»»» tagIconUrl/td>td>string/td>td>false/td>td>none/td>td>Tag icon URL/td>/tr>tr>td>»»» tag/td>td>string/td>td>false/td>td>none/td>td>Symbol Tag/td>/tr>tr>td>»»» riskTip/td>td>boolean/td>td>false/td>td>none/td>td>If it has risk tips/td>/tr>tr>td>»»» defaultLeverage/td>td>string/td>td>false/td>td>none/td>td>Default trade leverage/td>/tr>tr>td>»»» maxMarketSizeBuffer/td>td>string/td>td>false/td>td>none/td>td>Maximum market trade size buffer/td>/tr>tr>td>»»» enableFundingSettlement/td>td>boolean/td>td>false/td>td>none/td>td>Enable funding settlement/td>/tr>tr>td>»»» indexPriceDecimals/td>td>integer/td>td>false/td>td>none/td>td>Index price decimals/td>/tr>tr>td>»»» indexPriceVarRate/td>td>string/td>td>false/td>td>none/td>td>Index price var rate/td>/tr>tr>td>»»» openPositionOiLimitRate/td>td>string/td>td>false/td>td>none/td>td>Open position oi limit rate/td>/tr>tr>td>»»» fundingMaxRate/td>td>string/td>td>false/td>td>none/td>td>Funding maximum rate/td>/tr>tr>td>»»» fundingMinRate/td>td>string/td>td>false/td>td>none/td>td>Funding minimum rate/td>/tr>tr>td>»»» fundingMaxValue/td>td>string/td>td>false/td>td>none/td>td>Funding maximum value/td>/tr>tr>td>»»» enableFundingMxValue/td>td>boolean/td>td>false/td>td>none/td>td>Enable funding maximum value/td>/tr>tr>td>»»» l2PairId/td>td>string/td>td>false/td>td>none/td>td>zk l2 pair Id/td>/tr>tr>td>»»» settleTimeStamp/td>td>integer/td>td>false/td>td>none/td>td>Settle time/td>/tr>tr>td>»»» isPrelaunch/td>td>boolean/td>td>false/td>td>none/td>td>If it is prelaunch symbol/td>/tr>tr>td>»»» riskLimitConfig/td>td>object/td>td>false/td>td>none/td>td>Risk Limit config/td>/tr>tr>td>»»»» positionSteps/td>td>null/td>td>true/td>td>none/td>td>Position steps/td>/tr>tr>td>»»»» imrSteps/td>td>null/td>td>true/td>td>none/td>td>Initial margin rate steps/td>/tr>tr>td>»»»» mmrSteps/td>td>null/td>td>true/td>td>none/td>td>Maintenance margin rate steps/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-market-depth-v3>GET Market Depth V3/h2>p>code>GET /v3/depth/code>/p>p>Retrieve all active orderbook for one symbol, inclue all bids and asks./p>h3 idpublicapi-v3-for-omni-get-market-depth-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>depth_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/depth?symbolBTCUSDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>a/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.4/span>span classp>,/span>span classw> /span>span classs2>0.071/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.5/span>span classp>,/span>span classw> /span>span classs2>0.035/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>b/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.3/span>span classp>,/span>span classw> /span>span classs2>0.529/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.2/span>span classp>,/span>span classw> /span>span classs2>0.178/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>u/span>span classp>:/span>span classw> /span>span classmi>1076833/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>timeCost/span>span classp>:/span>span classw> /span>span classmi>1056809/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-market-depth-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-market-depth-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» a/td>td>array/td>td>false/td>td>none/td>td>Sell/td>/tr>tr>td>»» b/td>td>array/td>td>false/td>td>none/td>td>Buy/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» u/td>td>integer/td>td>false/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-newest-trading-data-v3>GET Newest Trading Data V3/h2>p>code>GET /v3/trades/code> /p>p>Retrieve trading data. /p>h3 idpublicapi-v3-for-omni-get-newest-trading-data-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data-v2>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit, maximum is 500/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>trades_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/trades?symbolBTCUSDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>S/span>span classp>:/span>span classw> /span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>v/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>p/span>span classp>:/span>span classw> /span>span classs2>29000/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>T/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-newest-trading-data-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-newest-trading-data-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» S/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» v/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» p/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» T/td>td>integer/td>td>false/td>td>none/td>td>Trade time/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-candlestick-chart-data-v3>GET Candlestick Chart Data V3/h2>p>code>GET /v3/klines/code> /p>p>Retrieves all candlestick chart data.br>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W" /p>h3 idpublicapi-v3-for-omni-get-candlestick-chart-data-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>interval/td>td>query/td>td>string/td>td>false/td>td>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W"/td>/tr>tr>td>start/td>td>query/td>td>string/td>td>false/td>td>Start time, second timestamp/td>/tr>tr>td>end/td>td>query/td>td>string/td>td>false/td>td>End time, second timestamp/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit, maximum is 200/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>klines/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDT/span>span classp>,/span>span classn>interval/span>span classo>/span>span classmi>5/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/klines?symbolBTCUSDT&interval5/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classmi>1647511440000/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>interval/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>low/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>high/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>open/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>close/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>volume/span>span classp>:/span>span classw> /span>span classs2>1.002/span>span classp>,/span>span classw> /span>span classnl>turnover/span>span classp>:/span>span classw> /span>span classs2>3/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-candlestick-chart-data-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-candlestick-chart-data-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» klines/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» start/td>td>integer/td>td>false/td>td>none/td>td>Start time/td>/tr>tr>td>»» symbol/td>td>string/td>td>true/td>td>none/td>td>Currency/td>/tr>tr>td>»» interval/td>td>string/td>td>true/td>td>none/td>td>Chart interval/td>/tr>tr>td>»» low/td>td>string/td>td>false/td>td>none/td>td>Low price/td>/tr>tr>td>»» high/td>td>string/td>td>false/td>td>none/td>td>High price/td>/tr>tr>td>»» open/td>td>string/td>td>false/td>td>none/td>td>Open price/td>/tr>tr>td>»» close/td>td>string/td>td>false/td>td>none/td>td>Close price/td>/tr>tr>td>»» volume/td>td>string/td>td>false/td>td>none/td>td>Trading volume/td>/tr>tr>td>»» turnover/td>td>string/td>td>false/td>td>none/td>td>Turnover/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-ticker-data-v3>GET Ticker Data V3/h2>p>code>GET /v3/ticker/code> /p>p>Get the latest data on symbol tickers. /p>h3 idpublicapi-v3-for-omni-get-ticker-data-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>ticker_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/ticker?symbolBTCUSDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>price24hPcnt/span>span classp>:/span>span classw> /span>span classs2>0.450141/span>span classp>,/span>span classw> /span>span classnl>lastPrice/span>span classp>:/span>span classw> /span>span classs2>43511.50/span>span classp>,/span>span classw> /span>span classnl>highPrice24h/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>lowPrice24h/span>span classp>:/span>span classw> /span>span classs2>29996.00/span>span classp>,/span>span classw> /span>span classnl>markPrice/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>indexPrice/span>span classp>:/span>span classw> /span>span classs2>40828.94/span>span classp>,/span>span classw> /span>span classnl>openInterest/span>span classp>:/span>span classw> /span>span classs2>2036854775808/span>span classp>,/span>span classw> /span>span classnl>turnover24h/span>span classp>:/span>span classw> /span>span classs2>5626085.23749999/span>span classp>,/span>span classw> /span>span classnl>volume24h/span>span classp>:/span>span classw> /span>span classs2>169.317/span>span classp>,/span>span classw> /span>span classnl>fundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>predictedFundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>nextFundingTime/span>span classp>:/span>span classw> /span>span classs2>10:00:00/span>span classp>,/span>span classw> /span>span classnl>tradeCount/span>span classp>:/span>span classw> /span>span classmi>100/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-ticker-data-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-ticker-data-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» tickers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» price24hPcnt/td>td>string/td>td>false/td>td>none/td>td>24H change (%)/td>/tr>tr>td>»» lastPrice/td>td>string/td>td>false/td>td>none/td>td>Last price/td>/tr>tr>td>»» highPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H highest price/td>/tr>tr>td>»» lowPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H lowest price/td>/tr>tr>td>»» markPrice/td>td>string/td>td>false/td>td>none/td>td>mark price/td>/tr>tr>td>»» indexPrice/td>td>string/td>td>false/td>td>none/td>td>Index price/td>/tr>tr>td>»» openInterest/td>td>string/td>td>false/td>td>none/td>td>Open interest/td>/tr>tr>td>»» turnover24h/td>td>string/td>td>false/td>td>none/td>td>24H turnover/td>/tr>tr>td>»» volume24h/td>td>string/td>td>false/td>td>none/td>td>24H trading volume/td>/tr>tr>td>»» fundingRate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» predictedFundingRate/td>td>string/td>td>false/td>td>none/td>td>Predicted funding rate/td>/tr>tr>td>»» nextFundingTime/td>td>string/td>td>false/td>td>none/td>td>Next funding rate/td>/tr>tr>td>»» tradeCount/td>td>string/td>td>false/td>td>none/td>td>24H trade count/td>/tr>/tbody>/table>h2 idpublicapi-v3-for-omni-get-funding-rate-history-v3>GET Funding Rate History V3/h2>p>code>GET /v3/history-funding/code>/p>h3 idpublicapi-v3-for-omni-get-funding-rate-history-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>Limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://omni.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>history_funding_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://omni.apex.exchange/api/v3/history-funding?symbolBTC-USDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyFunds/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>31297.5000008009374142/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classp>,/span>span classw> /span>span classnl>fundingTimestamp/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v3-for-omni-get-funding-rate-history-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v3-for-omni-get-funding-rate-history-v3-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historicalFunds/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» fundingTimestamp/td>td>integer/td>td>false/td>td>none/td>td>Funding timestamp/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Size/td>/tr>/tbody>/table>h1 idpublicapi-v2-for-pro>PublicApi V2 for Pro/h1>p>v2.0.0 /p>h2 idpublicapi-v2-for-pro-get-system-time-v2>GET System Time V2/h2>p>code>GET /v2/time/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>server_time/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/time/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>time/span>span classp>:/span>span classw> /span>span classmi>1648626529/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-system-time-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-system-time-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» time/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-all-config-data-v2>GET All Config Data V2/h2>p>USDC and USDT config/p>p>code>GET /v2/symbols/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>configs_v2/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/symbols/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>usdcConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>0x02893294412a4c8f915f75892b395ebbf6859ec246ec365c3b1f56f47c3a0a5d/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.000001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/USDC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/BTC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/ETH.svg/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>global/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>feeAccountId/span>span classp>:/span>span classw> /span>span classs2>10240000/span>span classp>,/span>span classw> /span>span classnl>feeAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>0x02382ceace17a59ec674b5ca7109eabc66e4107c7f473492cf192c60f4e17600/span>span classp>,/span>span classw> /span>span classnl>starkExCollateralCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExFundingValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>86400/span>span classp>,/span>span classw> /span>span classnl>starkExMaxFundingRate/span>span classp>:/span>span classw> /span>span classs2>2237/span>span classp>,/span>span classw> /span>span classnl>starkExOrdersTreeHeight/span>span classp>:/span>span classw> /span>span classmi>64/span>span classp>,/span>span classw> /span>span classnl>starkExPositionsTreeHeight/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>starkExPriceValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>86400/span>span classp>,/span>span classw> /span>span classnl>starkExContractAddress/span>span classp>:/span>span classw> /span>span classs2>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/span>span classp>,/span>span classw> /span>span classnl>registerEnvId/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>crossChainAccountId/span>span classp>:/span>span classw> /span>span classs2>351667704786059600/span>span classp>,/span>span classw> /span>span classnl>crossChainL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0270884a62b952837f1ad48bf28559c86060990af3e63019da59dad9cdd76ed0/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawAccountId/span>span classp>:/span>span classw> /span>span classs2>351667704786059600/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawFactRegisterAddress/span>span classp>:/span>span classw> /span>span classs2>0xBE9a129909EbCb954bC065536D2bfAfBd170d27A/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0270884a62b952837f1ad48bf28559c86060990af3e63019da59dad9cdd76ed0/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawMaxAmount/span>span classp>:/span>span classw> /span>span classs2>100000/span>span classp>,/span>span classw> /span>span classnl>bybitWithdrawAccountId/span>span classp>:/span>span classw> /span>span classs2>386890783493456500/span>span classp>,/span>span classw> /span>span classnl>bybitWithdrawL2Key/span>span classp>:/span>span classw> /span>span classs2>0x03a30ed5c0184757effbbc1df3921da538e514e289f342751333340d90962cf4/span>span classp>,/span>span classw> /span>span classnl>experienceMonenyAccountId/span>span classp>:/span>span classw> /span>span classs2>431772213377499661/span>span classp>,/span>span classw> /span>span classnl>experienceMonenyL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0577cf53e44275b3dfdfdfde1639752e35fff0cc6c2919b9389f087e87b16a8d/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyAccountId/span>span classp>:/span>span classw> /span>span classs2>431772213377499661/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0577cf53e44275b3dfdfdfde1639752e35fff0cc6c2919b9389f087e87b16a8d/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>perpetualContract/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>30000/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.5,1,2,5,10/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>30/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00250/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00100/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>200000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.03333/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.00700/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>130/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.0010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.025/span>span classp>,/span>span classw> /span>span classnl>settleCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExOraclePriceQuorum/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>10000000000/span>span classp>,/span>span classw> /span>span classnl>starkExRiskFactor/span>span classp>:/span>span classw> /span>span classs2>128849019/span>span classp>,/span>span classw> /span>span classnl>starkExSyntheticAssetId/span>span classp>:/span>span classw> /span>span classs2>0x4254432d3130000000000000000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName2/span>span classp>:/span>span classw> /span>span classs2>BTCUSD/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.5/span>span classp>,/span>span classw> /span>span classnl>underlyingCurrencyId/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.03000/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classw> /span>span classs2>10050000.0000/span>span classp>,/span>span classw> /span>span classnl>tagIconUrl/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>tag/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>riskTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultLeverage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>klineStartTime/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>multiChain/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chains/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>Ethereum/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_logos/Ethereum.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0xe95b3Dc78c0881dEa17A69BaFC6cFeB8d891e9DE/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://eth-mainnet.alchemyapi.io/v2/sNRPO_qXIfkVdfpcj33LId04rmHugka2/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://eth-mainnet.alchemyapi.io/v2/sNRPO_qXIfkVdfpcj33LId04rmHugka2/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://etherscan.io/tx//span>span classp>,/span>span classw> /span>span classnl>blockTime/span>span classp>:/span>span classw> /span>span classs2>15/span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xdAC17F958D2ee523a2206206994597C13D831ec7/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_ETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_DAI.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>DAI/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x6b175474e89094c44da98b954eedeac495271d0f/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>DAI/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isGray/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>BNB Chain(BSC)/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>56/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BNB.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0xe29304Af265641a49F55294F7E5BA5010ebA4497/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://bsc-dataseed3.binance.org/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://bsc-dataseed3.binance.org/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://bscscan.com/tx//span>span classp>,/span>span classw> /span>span classnl>blockTime/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x55d398326f99059fF775485246999027B3197955/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BNB.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BUSD.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BUSD/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xe9e7CEA3DedcA5984780Bafc599bD69ADd087D56/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>BUSD/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isGray/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>maxWithdraw/span>span classp>:/span>span classw> /span>span classs2>100000/span>span classp>,/span>span classw> /span>span classnl>minDeposit/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>minWithdraw/span>span classp>:/span>span classw> /span>span classs2>8/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>depositFromBybit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>usdtConfig/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>0x02ce625e94458d39dd0bf3b45a843544dd4a14b8169045a3a3d15aa564b936c5/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.000001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDT.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/BTC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/ETH.svg/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>global/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>feeAccountId/span>span classp>:/span>span classw> /span>span classs2>10240000/span>span classp>,/span>span classw> /span>span classnl>feeAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>0x02382ceace17a59ec674b5ca7109eabc66e4107c7f473492cf192c60f4e17600/span>span classp>,/span>span classw> /span>span classnl>starkExCollateralCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>starkExFundingValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>86400/span>span classp>,/span>span classw> /span>span classnl>starkExMaxFundingRate/span>span classp>:/span>span classw> /span>span classs2>2237/span>span classp>,/span>span classw> /span>span classnl>starkExOrdersTreeHeight/span>span classp>:/span>span classw> /span>span classmi>64/span>span classp>,/span>span classw> /span>span classnl>starkExPositionsTreeHeight/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>starkExPriceValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>86400/span>span classp>,/span>span classw> /span>span classnl>starkExContractAddress/span>span classp>:/span>span classw> /span>span classs2>0xe53A6eD882Eb3f90cCe0390DDB04c876C5482E6b/span>span classp>,/span>span classw> /span>span classnl>registerEnvId/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>crossChainAccountId/span>span classp>:/span>span classw> /span>span classs2>503102754309276028/span>span classp>,/span>span classw> /span>span classnl>crossChainL2Key/span>span classp>:/span>span classw> /span>span classs2>0x05dc82afffe0311f532b3ee86fbf5491fc4be1a3e7a204a37e69416999f00dfc/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawAccountId/span>span classp>:/span>span classw> /span>span classs2>503102754309276028/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawFactRegisterAddress/span>span classp>:/span>span classw> /span>span classs2>0xBE9a129909EbCb954bC065536D2bfAfBd170d27A/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawL2Key/span>span classp>:/span>span classw> /span>span classs2>0x05dc82afffe0311f532b3ee86fbf5491fc4be1a3e7a204a37e69416999f00dfc/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawMaxAmount/span>span classp>:/span>span classw> /span>span classs2>100000/span>span classp>,/span>span classw> /span>span classnl>bybitWithdrawAccountId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>bybitWithdrawL2Key/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>experienceMonenyAccountId/span>span classp>:/span>span classw> /span>span classs2>503102758994313516/span>span classp>,/span>span classw> /span>span classnl>experienceMonenyL2Key/span>span classp>:/span>span classw> /span>span classs2>0x01402668ab56fef0c44ec9d0569f2706f08caa4bc29ee2eb2f9376d86bc5adac/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyAccountId/span>span classp>:/span>span classw> /span>span classs2>503102758994313516/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyL2Key/span>span classp>:/span>span classw> /span>span classs2>0x01402668ab56fef0c44ec9d0569f2706f08caa4bc29ee2eb2f9376d86bc5adac/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>perpetualContract/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>30001/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>34/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.1,0.2,0.4,1,2/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0075/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.005/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>150000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>130/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.0010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.025/span>span classp>,/span>span classw> /span>span classnl>settleCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>starkExOraclePriceQuorum/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>10000000000/span>span classp>,/span>span classw> /span>span classnl>starkExRiskFactor/span>span classp>:/span>span classw> /span>span classs2>1417339208/span>span classp>,/span>span classw> /span>span classnl>starkExSyntheticAssetId/span>span classp>:/span>span classw> /span>span classs2>0x4254432d3130000000000000000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName2/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>underlyingCurrencyId/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.3300/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classw> /span>span classs2>9650000/span>span classp>,/span>span classw> /span>span classnl>tagIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/LABLE_HOT.svg/span>span classp>,/span>span classw> /span>span classnl>tag/span>span classp>:/span>span classw> /span>span classs2>HOT/span>span classp>,/span>span classw> /span>span classnl>riskTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultLeverage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>klineStartTime/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>50000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>30001/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>35/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>ETHUSDT/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.01,0.02,0.04,0.1,0.2/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0075/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.005/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>150000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>800/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>1700/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.045/span>span classp>,/span>span classw> /span>span classnl>settleCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>starkExOraclePriceQuorum/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>100000000/span>span classp>,/span>span classw> /span>span classnl>starkExRiskFactor/span>span classp>:/span>span classw> /span>span classs2>1417339208/span>span classp>,/span>span classw> /span>span classnl>starkExSyntheticAssetId/span>span classp>:/span>span classw> /span>span classs2>0x4554482d3800000000000000000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>ETHUSDT/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName2/span>span classp>:/span>span classw> /span>span classs2>ETHUSDT/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.01/span>span classp>,/span>span classw> /span>span classnl>underlyingCurrencyId/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.3300/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classw> /span>span classs2>9650000/span>span classp>,/span>span classw> /span>span classnl>tagIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/LABLE_HOT.svg/span>span classp>,/span>span classw> /span>span classnl>tag/span>span classp>:/span>span classw> /span>span classs2>HOT/span>span classp>,/span>span classw> /span>span classnl>riskTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultLeverage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>klineStartTime/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>multiChain/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chains/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>Ethereum/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_logos/Ethereum.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x379c15156B527D6E693bED60d1FBb44CE46046b8/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://eth-mainnet.alchemyapi.io/v2/sNRPO_qXIfkVdfpcj33LId04rmHugka2/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://eth-mainnet.alchemyapi.io/v2/sNRPO_qXIfkVdfpcj33LId04rmHugka2/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://etherscan.io/tx//span>span classp>,/span>span classw> /span>span classnl>blockTime/span>span classp>:/span>span classw> /span>span classs2>15/span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xdAC17F958D2ee523a2206206994597C13D831ec7/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/icon/USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_ETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Ethereum/Ethereum_DAI.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>DAI/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x6b175474e89094c44da98b954eedeac495271d0f/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>DAI/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isGray/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>BNB Chain(BSC)/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>56/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BNB.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x7B71Ff8451706B9e863879a84bf967Ff4Dc7A9bF/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://bsc-dataseed3.binance.org/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://bsc-dataseed3.binance.org/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://bscscan.com/tx//span>span classp>,/span>span classw> /span>span classnl>blockTime/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>15/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x55d398326f99059fF775485246999027B3197955/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BNB.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>BNB/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/BSC/BNB_BUSD.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>BUSD/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xe9e7CEA3DedcA5984780Bafc599bD69ADd087D56/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>BUSD/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isGray/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>Arbitrum One/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>42161/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_logos/Arbitrum.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x192DB9Fe1C0b9D7c6B4045e4F029b21792c68165/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopDeposit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classnl>dynamicFee/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://arb1.arbitrum.io/rpc/span>span classp>,/span>span classw> /span>span classnl>webRpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://arb1.arbitrum.io/rpc/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://arbiscan.io/tx//span>span classp>,/span>span classw> /span>span classnl>blockTime/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Arbitrum/Arbitrum_USDT.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Arbitrum/Arbitrum_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC.e/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Arbitrum/Arbitrum_USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC.o/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xaf88d065e77c8cC2239327C5EDb3A432268e5831/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Arbitrum/Arbitrum_ETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://static-pro.apex.exchange/chains/chain_tokens/Arbitrum/Arbitrum_WETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>WETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0x82aF49447D8a07e3bd95BD0d56f35241523fBab1/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>withdrawEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>slippage/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isDefaultToken/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>displayToken/span>span classp>:/span>span classw> /span>span classs2>WETH/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isGray/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>maxWithdraw/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>minDeposit/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>minWithdraw/span>span classp>:/span>span classw> /span>span classs2>8/span>span classw> /span>span classp>},/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>timeCost/span>span classp>:/span>span classw> /span>span classmi>1416146/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-all-config-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-all-config-data-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» global/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» feeAccountId/td>td>string/td>td>true/td>td>none/td>td>Trading fee system account id/td>/tr>tr>td>»» feeAccountL2Key/td>td>string/td>td>true/td>td>none/td>td>Trading fee system l2Key/td>/tr>tr>td>»» starkExCollateralCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Starkex supported collateral asset id/td>/tr>tr>td>»» starkExMaxFundingRate/td>td>string/td>td>true/td>td>none/td>td>Maximum funding rate/td>/tr>tr>td>»» starkExOrdersTreeHeight/td>td>integer/td>td>true/td>td>none/td>td>Order merkle tree height/td>/tr>tr>td>»» starkExPositionsTreeHeight/td>td>integer/td>td>true/td>td>none/td>td>Account merkle tree height/td>/tr>tr>td>»» starkExFundingValidityPeriod/td>td>integer/td>td>true/td>td>none/td>td>L2 funding validity period/td>/tr>tr>td>»» starkExPriceValidityPeriod/td>td>integer/td>td>true/td>td>none/td>td>L2 price validity period/td>/tr>tr>td>»» fastWithdrawAccountId/td>td>string/td>td>true/td>td>none/td>td>Fast withdraw system account id/td>/tr>tr>td>»» fastWithdrawL2Key/td>td>string/td>td>true/td>td>none/td>td>Fast withdraw system l2Key/td>/tr>tr>td>»» fastWithdrawMaxAmount/td>td>string/td>td>true/td>td>none/td>td>Maximum Fast withdraw amount/td>/tr>tr>td>»» fastWithdrawFactRegisterAddress/td>td>string/td>td>true/td>td>none/td>td>L1 Fact registered contract address/td>/tr>tr>td>»» crossChainAccountId/td>td>string/td>td>true/td>td>none/td>td>Cross chain withdraw account id/td>/tr>tr>td>»» crossChainL2Key/td>td>string/td>td>true/td>td>none/td>td>Cross chain withdraw system l2Key/td>/tr>tr>td>»» registerChainId/td>td>integer/td>td>true/td>td>5/td>td>The 'envId' is initially filled during onboarding, serving to differentiate environments, with 1 indicating the production environment and 5 representing testing environments./td>/tr>tr>td>» currency/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>Token name/td>/tr>tr>td>»» stepSize/td>td>string/td>td>true/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»» starkExAssetId/td>td>string/td>td>false/td>td>none/td>td>StarkEx asset id/td>/tr>tr>td>»» starkExResolution/td>td>string/td>td>false/td>td>none/td>td>StarkEx resolution/td>/tr>tr>td>» multiChain/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» maxWithdraw/td>td>string/td>td>true/td>td>none/td>td>Maximum withdrawal amount/td>/tr>tr>td>»» minWithdraw/td>td>string/td>td>true/td>td>none/td>td>Minimum withdrawal amount/td>/tr>tr>td>»» minDeposit/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit amount/td>/tr>tr>td>»» currency/td>td>string/td>td>true/td>td>USDC/td>td>Currency/td>/tr>tr>td>»» chains/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»» chain/td>td>string/td>td>true/td>td>none/td>td>Chain/td>/tr>tr>td>»»» contractAddress/td>td>string/td>td>true/td>td>none/td>td>Contract address/td>/tr>tr>td>»»» chainIconUrl/td>td>string/td>td>true/td>td>none/td>td>Chain icon url/td>/tr>tr>td>»»» gasToken/td>td>string/td>td>true/td>td>none/td>td>Gas token name/td>/tr>tr>td>»»» rpcUrl/td>td>string/td>td>true/td>td>none/td>td>Chain RPC service Url/td>/tr>tr>td>»»» chainId/td>td>integer/td>td>true/td>td>none/td>td>Chain ID/td>/tr>tr>td>»»» feeLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable trading fees/td>/tr>tr>td>»»» depositGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable deposit gas fees/td>/tr>tr>td>»»» withdrawGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable withdraw gas fees/td>/tr>tr>td>»»» minFee/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit gas fee: If gas+value*fee_rate is lesser than min_fee, min_fee amount will be charged instead/td>/tr>tr>td>»»» feeRate/td>td>string/td>td>true/td>td>none/td>td>Fee rate/td>/tr>tr>td>»»» webTxUrl/td>td>string/td>td>true/td>td>none/td>td>Transaction tx URL/td>/tr>tr>td>»»» tokens/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»»» token/td>td>string/td>td>true/td>td>none/td>td>Token name/td>/tr>tr>td>»»»» tokenAddress/td>td>string/td>td>true/td>td>none/td>td>Token address/td>/tr>tr>td>»»»» decimals/td>td>integer/td>td>true/td>td>none/td>td>Token decimal point accuracy/td>/tr>tr>td>»»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Token icon URL/td>/tr>tr>td>»»»» pullOff/td>td>bool/td>td>true/td>td>none/td>td>Enable taking down of listing, default as FALSE/td>/tr>tr>td>»»» gasLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable gas free transaction/td>/tr>tr>td>» perpetualContract/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>true/td>td>none/td>td>Symbol id/td>/tr>tr>td>»» symbolDisplayName/td>td>string/td>td>true/td>td>none/td>td>Symbol display name/td>/tr>tr>td>»» settleCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Settlement asset id/td>/tr>tr>td>»» underlyingCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Underlying asset id/td>/tr>tr>td>»» tickSize/td>td>string/td>td>true/td>td>none/td>td>Minimum tick size/td>/tr>tr>td>»» stepSize/td>td>string/td>td>true/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»» minOrderSize/td>td>string/td>td>true/td>td>none/td>td>Minimum order size/td>/tr>tr>td>»» maxOrderSize/td>td>string/td>td>true/td>td>none/td>td>Maximum order size/td>/tr>tr>td>»» maxPositionSize/td>td>string/td>td>true/td>td>none/td>td>Maximum position size/td>/tr>tr>td>»» maxMarketPriceRange/td>td>string/td>td>true/td>td>none/td>td>Maximum market price rangee/td>/tr>tr>td>»» initialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Initial margin rate/td>/tr>tr>td>»» maintenanceMarginRate/td>td>string/td>td>true/td>td>none/td>td>Maintenance margin rate/td>/tr>tr>td>»» baselinePositionValue/td>td>string/td>td>true/td>td>none/td>td>Baseline position vaue/td>/tr>tr>td>»» incrementalPositionValue/td>td>string/td>td>true/td>td>none/td>td>Incremental position value/td>/tr>tr>td>»» incrementalInitialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Incremental initial margin rate/td>/tr>tr>td>»» incrementalMaintenanceMarginRate/td>td>string/td>td>true/td>td>none/td>td>Incremental maintenance margin rate/td>/tr>tr>td>»» enableTrade/td>td>boolean/td>td>true/td>td>none/td>td>Enable trade/td>/tr>tr>td>»» enableDisplay/td>td>boolean/td>td>true/td>td>none/td>td>Enable display/td>/tr>tr>td>»» enableOpenPosition/td>td>boolean/td>td>true/td>td>none/td>td>Enable open position/td>/tr>tr>td>»» digitMerge/td>td>string/td>td>true/td>td>none/td>td>Depth digit merge/td>/tr>tr>td>»» crossId/td>td>integer/td>td>true/td>td>none/td>td>Quote API use id for symbol/td>/tr>tr>td>»» crossSymbolId/td>td>integer/td>td>true/td>td>none/td>td>Quote API use symbolId for symbol/td>/tr>tr>td>»» crossSymbolName/td>td>string/td>td>true/td>td>none/td>td>Quote API use symbolName for symbol/td>/tr>tr>td>»» fundingInterestRate/td>td>string/td>td>true/td>td>none/td>td>Funding rate ratio/td>/tr>tr>td>»» fundingImpactMarginNotional/td>td>string/td>td>true/td>td>none/td>td>Not required on frontend/td>/tr>tr>td>»» displayMaxLeverage/td>td>string/td>td>true/td>td>none/td>td>Maximum leverage/td>/tr>tr>td>»» displayMinLeverage/td>td>string/td>td>true/td>td>none/td>td>Minimum leverage/td>/tr>tr>td>»» starkExSyntheticAssetId/td>td>string/td>td>true/td>td>none/td>td>Currency synthetic asset id/td>/tr>tr>td>»» starkExResolution/td>td>string/td>td>true/td>td>none/td>td>Currency resolution/td>/tr>tr>td>»» starkExRiskFactor/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» starkExOraclePriceQuorum/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-market-depth-v2>GET Market Depth V2/h2>p>code>GET /v2/depth/code>/p>p>Retrieve all active orderbook for one symbol, inclue all bids and asks./p>h3 idpublicapi-v2-for-pro-get-market-depth-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>depth/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/depth?symbolBTCUSDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>a/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.4/span>span classp>,/span>span classw> /span>span classs2>0.071/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.5/span>span classp>,/span>span classw> /span>span classs2>0.035/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>b/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.3/span>span classp>,/span>span classw> /span>span classs2>0.529/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.2/span>span classp>,/span>span classw> /span>span classs2>0.178/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>u/span>span classp>:/span>span classw> /span>span classmi>1076833/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>timeCost/span>span classp>:/span>span classw> /span>span classmi>1056809/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-market-depth-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-market-depth-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» a/td>td>array/td>td>false/td>td>none/td>td>Sell/td>/tr>tr>td>»» b/td>td>array/td>td>false/td>td>none/td>td>Buy/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» u/td>td>integer/td>td>false/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-newest-trading-data-v2>GET Newest Trading Data V2/h2>p>code>GET /v2/trades/code> /p>p>Retrieve trading data. /p>h3 idpublicapi-v2-for-pro-get-newest-trading-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data-v2>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit, maximum is 500/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>trades/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/trades?symbolBTCUSDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>S/span>span classp>:/span>span classw> /span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>v/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>p/span>span classp>:/span>span classw> /span>span classs2>29000/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>T/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-newest-trading-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-newest-trading-data-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» S/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» v/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» p/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» T/td>td>integer/td>td>false/td>td>none/td>td>Trade time/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-candlestick-chart-data-v2>GET Candlestick Chart Data V2/h2>p>code>GET /v2/klines/code> /p>p>Retrieves all candlestick chart data.br>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W" /p>h3 idpublicapi-v2-for-pro-get-candlestick-chart-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>interval/td>td>query/td>td>string/td>td>false/td>td>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W"/td>/tr>tr>td>start/td>td>query/td>td>string/td>td>false/td>td>Start time, second timestamp/td>/tr>tr>td>end/td>td>query/td>td>string/td>td>false/td>td>End time, second timestamp/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit,, maximum is 1500/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>klines/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>,/span>span classn>interval/span>span classo>/span>span classmi>5/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/klines?symbolBTCUSDC?interval5/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classmi>1647511440000/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>interval/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>low/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>high/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>open/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>close/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>volume/span>span classp>:/span>span classw> /span>span classs2>1.002/span>span classp>,/span>span classw> /span>span classnl>turnover/span>span classp>:/span>span classw> /span>span classs2>3/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-candlestick-chart-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-candlestick-chart-data-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» klines/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» start/td>td>integer/td>td>false/td>td>none/td>td>Start time/td>/tr>tr>td>»» symbol/td>td>string/td>td>true/td>td>none/td>td>Currency/td>/tr>tr>td>»» interval/td>td>string/td>td>true/td>td>none/td>td>Chart interval/td>/tr>tr>td>»» low/td>td>string/td>td>false/td>td>none/td>td>Low price/td>/tr>tr>td>»» high/td>td>string/td>td>false/td>td>none/td>td>High price/td>/tr>tr>td>»» open/td>td>string/td>td>false/td>td>none/td>td>Open price/td>/tr>tr>td>»» close/td>td>string/td>td>false/td>td>none/td>td>Close price/td>/tr>tr>td>»» volume/td>td>string/td>td>false/td>td>none/td>td>Trading volume/td>/tr>tr>td>»» turnover/td>td>string/td>td>false/td>td>none/td>td>Turnover/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-ticker-data-v2>GET Ticker Data V2/h2>p>code>GET /v2/ticker/code> /p>p>Get the latest data on symbol tickers. /p>h3 idpublicapi-v2-for-pro-get-ticker-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>ticker/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/ticker?symbolBTCUSDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>price24hPcnt/span>span classp>:/span>span classw> /span>span classs2>0.450141/span>span classp>,/span>span classw> /span>span classnl>lastPrice/span>span classp>:/span>span classw> /span>span classs2>43511.50/span>span classp>,/span>span classw> /span>span classnl>highPrice24h/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>lowPrice24h/span>span classp>:/span>span classw> /span>span classs2>29996.00/span>span classp>,/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>indexPrice/span>span classp>:/span>span classw> /span>span classs2>40828.94/span>span classp>,/span>span classw> /span>span classnl>openInterest/span>span classp>:/span>span classw> /span>span classs2>2036854775808/span>span classp>,/span>span classw> /span>span classnl>turnover24h/span>span classp>:/span>span classw> /span>span classs2>5626085.23749999/span>span classp>,/span>span classw> /span>span classnl>volume24h/span>span classp>:/span>span classw> /span>span classs2>169.317/span>span classp>,/span>span classw> /span>span classnl>fundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>predictedFundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>nextFundingTime/span>span classp>:/span>span classw> /span>span classs2>10:00:00/span>span classp>,/span>span classw> /span>span classnl>tradeCount/span>span classp>:/span>span classw> /span>span classmi>100/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-ticker-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-ticker-data-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» tickers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» price24hPcnt/td>td>string/td>td>false/td>td>none/td>td>24H change (%)/td>/tr>tr>td>»» lastPrice/td>td>string/td>td>false/td>td>none/td>td>Last price/td>/tr>tr>td>»» highPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H highest price/td>/tr>tr>td>»» lowPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H lowest price/td>/tr>tr>td>»» oraclePrice/td>td>string/td>td>false/td>td>none/td>td>Oracle price/td>/tr>tr>td>»» indexPrice/td>td>string/td>td>false/td>td>none/td>td>Index price/td>/tr>tr>td>»» openInterest/td>td>string/td>td>false/td>td>none/td>td>Open interest/td>/tr>tr>td>»» turnover24h/td>td>string/td>td>false/td>td>none/td>td>24H turnover/td>/tr>tr>td>»» volume24h/td>td>string/td>td>false/td>td>none/td>td>24H trading volume/td>/tr>tr>td>»» fundingRate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» predictedFundingRate/td>td>string/td>td>false/td>td>none/td>td>Predicted funding rate/td>/tr>tr>td>»» nextFundingTime/td>td>string/td>td>false/td>td>none/td>td>Next funding rate/td>/tr>tr>td>»» tradeCount/td>td>string/td>td>false/td>td>none/td>td>24H trade count/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-funding-rate-history-v2>GET Funding Rate History V2/h2>p>code>GET /v2/history-funding/code>/p>h3 idpublicapi-v2-for-pro-get-funding-rate-history-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>Limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>history_funding_v2/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v2/history-funding?symbolBTC-USDT/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyFunds/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>31297.5000008009374142/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classp>,/span>span classw> /span>span classnl>fundingTimestamp/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-funding-rate-history-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-funding-rate-history-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historicalFunds/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» fundingTimestamp/td>td>integer/td>td>false/td>td>none/td>td>Funding timestamp/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Size/td>/tr>/tbody>/table>h2 idpublicapi-v2-for-pro-get-check-if-user-exists-v2>GET Check If User Exists V2/h2>p>code>GET /v2/check-user-exist/code>/p>h3 idpublicapi-v2-for-pro-get-check-if-user-exists-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>ethAddress/td>td>query/td>td>string/td>td>FALSE/td>td>0x111111/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-v2-for-pro-get-check-if-user-exists-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Value/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-v2-for-pro-get-check-if-user-exists-v2-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h1 idpublicapi>PublicApi/h1>p>v1.0.0 /p>h2 idpublicapi-get-system-time>GET System Time/h2>p>code>GET /v1/time/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>server_time/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/time/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>time/span>span classp>:/span>span classw> /span>span classmi>1648626529/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-system-time-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-system-time-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» time/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-get-all-config-data>GET All Config Data/h2>p>code>GET /v1/symbols/code>/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>configs/span>span classp>()/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/symbols/span> /code>/pre>/div>blockquote>p>Successful Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.000001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>starkExAssetId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.0001/span>span classp>,/span>span classw> /span>span classnl>showStep/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/BTC.svg/span>span classw> /span>span classp>},/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>global/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>feeAccountId/span>span classp>:/span>span classw> /span>span classs2>10240000/span>span classp>,/span>span classw> /span>span classnl>feeAccountL2Key/span>span classp>:/span>span classw> /span>span classs2>0x05d08ae9202f9e19ffa0211676536ba3e4c5f1e433a4c01d60fceae00a095100/span>span classp>,/span>span classw> /span>span classnl>starkExCollateralCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExFundingValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>604800/span>span classp>,/span>span classw> /span>span classnl>starkExMaxFundingRate/span>span classp>:/span>span classw> /span>span classs2>1120/span>span classp>,/span>span classw> /span>span classnl>starkExOrdersTreeHeight/span>span classp>:/span>span classw> /span>span classmi>64/span>span classp>,/span>span classw> /span>span classnl>starkExPositionsTreeHeight/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>starkExPriceValidityPeriod/span>span classp>:/span>span classw> /span>span classmi>31536000/span>span classp>,/span>span classw> /span>span classnl>starkExContractAddress/span>span classp>:/span>span classw> /span>span classs2>0x7478037C3a1F44f0Add4Ae06158fefD10d44Bb63/span>span classp>,/span>span classw> /span>span classnl>registerEnvId/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classnl>crossChainAccountId/span>span classp>:/span>span classw> /span>span classs2>349914288015540743/span>span classp>,/span>span classw> /span>span classnl>crossChainL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0486880561f5ddb979c92dcd4eefdedeb050bc5aad3522b00b211855f3c2ca87/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawAccountId/span>span classp>:/span>span classw> /span>span classs2>349914288015540743/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawFactRegisterAddress/span>span classp>:/span>span classw> /span>span classs2>0x5070F5d37419AEAd10Df2252421e457336561269/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawL2Key/span>span classp>:/span>span classw> /span>span classs2>0x0486880561f5ddb979c92dcd4eefdedeb050bc5aad3522b00b211855f3c2ca87/span>span classp>,/span>span classw> /span>span classnl>fastWithdrawMaxAmount/span>span classp>:/span>span classw> /span>span classs2>100000/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>perpetualContract/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>baselinePositionValue/span>span classp>:/span>span classw> /span>span classs2>1000000.0000/span>span classp>,/span>span classw> /span>span classnl>crossId/span>span classp>:/span>span classw> /span>span classmi>30000/span>span classp>,/span>span classw> /span>span classnl>crossSymbolId/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classnl>crossSymbolName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>digitMerge/span>span classp>:/span>span classw> /span>span classs2>0.5,1,2,5/span>span classp>,/span>span classw> /span>span classnl>displayMaxLeverage/span>span classp>:/span>span classw> /span>span classs2>20/span>span classp>,/span>span classw> /span>span classnl>displayMinLeverage/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>enableDisplay/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableOpenPosition/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>enableTrade/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>fundingImpactMarginNotional/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>fundingInterestRate/span>span classp>:/span>span classw> /span>span classs2>0.0003/span>span classp>,/span>span classw> /span>span classnl>incrementalInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0075/span>span classp>,/span>span classw> /span>span classnl>incrementalMaintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0000/span>span classp>,/span>span classw> /span>span classnl>incrementalPositionValue/span>span classp>:/span>span classw> /span>span classs2>1000000.0000/span>span classp>,/span>span classw> /span>span classnl>initialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0500/span>span classp>,/span>span classw> /span>span classnl>maintenanceMarginRate/span>span classp>:/span>span classw> /span>span classs2>0.0300/span>span classp>,/span>span classw> /span>span classnl>maxOrderSize/span>span classp>:/span>span classw> /span>span classs2>100.0000/span>span classp>,/span>span classw> /span>span classnl>maxPositionSize/span>span classp>:/span>span classw> /span>span classs2>500.0000/span>span classp>,/span>span classw> /span>span classnl>minOrderSize/span>span classp>:/span>span classw> /span>span classs2>0.0010/span>span classp>,/span>span classw> /span>span classnl>maxMarketPriceRange/span>span classp>:/span>span classw> /span>span classs2>0.03/span>span classp>,/span>span classw> /span>span classnl>settleCurrencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>starkExOraclePriceQuorum/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>starkExResolution/span>span classp>:/span>span classw> /span>span classs2>10000000000/span>span classp>,/span>span classw> /span>span classnl>starkExRiskFactor/span>span classp>:/span>span classw> /span>span classs2>128849019/span>span classp>,/span>span classw> /span>span classnl>starkExSyntheticAssetId/span>span classp>:/span>span classw> /span>span classs2>0x4254432d3130000000000000000000/span>span classp>,/span>span classw> /span>span classnl>stepSize/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>symbolDisplayName/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>tickSize/span>span classp>:/span>span classw> /span>span classs2>0.5/span>span classp>,/span>span classw> /span>span classnl>underlyingCurrencyId/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classnl>maxMaintenanceMarginRate/span>span classp>:/span>span classs2>0.03000/span>span classp>,/span>span classw> /span>span classnl>maxPositionValue/span>span classp>:/span>span classs2>10150000.0000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>multiChain/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chains/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chain/span>span classp>:/span>span classw> /span>span classs2>Goerli - Testnet/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classnl>chainIconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/chains/chain_logos/Goerli.svg/span>span classp>,/span>span classw> /span>span classnl>contractAddress/span>span classp>:/span>span classw> /span>span classs2>0x4c0023E8c570D4c3Bd357e7869027cF0106Ed3B7/span>span classp>,/span>span classw> /span>span classnl>depositGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>feeRate/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>gasLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>gasToken/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>minFee/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>rpcUrl/span>span classp>:/span>span classw> /span>span classs2>https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161/span>span classp>,/span>span classw> /span>span classnl>webTxUrl/span>span classp>:/span>span classw> /span>span classs2>https://goerli.etherscan.io/tx//span>span classp>,/span>span classw> /span>span classnl>txConfirm/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classnl>tokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>6/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/USDC.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>0xd44BB808bfE43095dBb94c83077766382D63952a/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>decimals/span>span classp>:/span>span classw> /span>span classmi>18/span>span classp>,/span>span classw> /span>span classnl>iconUrl/span>span classp>:/span>span classw> /span>span classs2>https://l2dex-image-static.dev.apexplus.exchange/icon/ETH.svg/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>tokenAddress/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>pullOff/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>withdrawGasFeeLess/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>currency/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>maxWithdraw/span>span classp>:/span>span classw> /span>span classs2>100000/span>span classp>,/span>span classw> /span>span classnl>minDeposit/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classnl>minWithdraw/span>span classp>:/span>span classw> /span>span classs2>10/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>timeCost/span>span classp>:/span>span classw> /span>span classmi>266616/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-all-config-data-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-all-config-data-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» global/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» feeAccountId/td>td>string/td>td>true/td>td>none/td>td>Trading fee system account id/td>/tr>tr>td>»» feeAccountL2Key/td>td>string/td>td>true/td>td>none/td>td>Trading fee system l2Key/td>/tr>tr>td>»» starkExCollateralCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Starkex supported collateral asset id/td>/tr>tr>td>»» starkExMaxFundingRate/td>td>string/td>td>true/td>td>none/td>td>Maximum funding rate/td>/tr>tr>td>»» starkExOrdersTreeHeight/td>td>integer/td>td>true/td>td>none/td>td>Order merkle tree height/td>/tr>tr>td>»» starkExPositionsTreeHeight/td>td>integer/td>td>true/td>td>none/td>td>Account merkle tree height/td>/tr>tr>td>»» starkExFundingValidityPeriod/td>td>integer/td>td>true/td>td>none/td>td>L2 funding validity period/td>/tr>tr>td>»» starkExPriceValidityPeriod/td>td>integer/td>td>true/td>td>none/td>td>L2 price validity period/td>/tr>tr>td>»» fastWithdrawAccountId/td>td>string/td>td>true/td>td>none/td>td>Fast withdraw system account id/td>/tr>tr>td>»» fastWithdrawL2Key/td>td>string/td>td>true/td>td>none/td>td>Fast withdraw system l2Key/td>/tr>tr>td>»» fastWithdrawMaxAmount/td>td>string/td>td>true/td>td>none/td>td>Maximum Fast withdraw amount/td>/tr>tr>td>»» fastWithdrawFactRegisterAddress/td>td>string/td>td>true/td>td>none/td>td>L1 Fact registered contract address/td>/tr>tr>td>»» crossChainAccountId/td>td>string/td>td>true/td>td>none/td>td>Cross chain withdraw account id/td>/tr>tr>td>»» crossChainL2Key/td>td>string/td>td>true/td>td>none/td>td>Cross chain withdraw system l2Key/td>/tr>tr>td>»» registerChainId/td>td>integer/td>td>true/td>td>5/td>td>envId initially filled during onboarding: Differentiate by environment with 1 as production and 5 as testing environments/td>/tr>tr>td>» currency/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>Token name/td>/tr>tr>td>»» stepSize/td>td>string/td>td>true/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»» starkExAssetId/td>td>string/td>td>false/td>td>none/td>td>StarkEx asset id/td>/tr>tr>td>»» starkExResolution/td>td>string/td>td>false/td>td>none/td>td>StarkEx resolution/td>/tr>tr>td>» multiChain/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» maxWithdraw/td>td>string/td>td>true/td>td>none/td>td>Maximum withdrawal amount/td>/tr>tr>td>»» minWithdraw/td>td>string/td>td>true/td>td>none/td>td>Minimum withdrawal amount/td>/tr>tr>td>»» minDeposit/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit amount/td>/tr>tr>td>»» currency/td>td>string/td>td>true/td>td>USDC/td>td>Currency/td>/tr>tr>td>»» chains/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»» chain/td>td>string/td>td>true/td>td>none/td>td>Chain/td>/tr>tr>td>»»» contractAddress/td>td>string/td>td>true/td>td>none/td>td>Contract address/td>/tr>tr>td>»»» chainIconUrl/td>td>string/td>td>true/td>td>none/td>td>Chain icon url/td>/tr>tr>td>»»» gasToken/td>td>string/td>td>true/td>td>none/td>td>Gas token name/td>/tr>tr>td>»»» rpcUrl/td>td>string/td>td>true/td>td>none/td>td>Chain RPC service Url/td>/tr>tr>td>»»» chainId/td>td>integer/td>td>true/td>td>none/td>td>Chain ID/td>/tr>tr>td>»»» feeLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable trading fees/td>/tr>tr>td>»»» depositGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable deposit gas fees/td>/tr>tr>td>»»» withdrawGasFeeLess/td>td>boolean/td>td>false/td>td>none/td>td>Enable withdraw gas fees/td>/tr>tr>td>»»» minFee/td>td>string/td>td>true/td>td>none/td>td>Minimum deposit gas fee: If gas+value*fee_rate is lesser than min_fee, min_fee amount will be charged instead/td>/tr>tr>td>»»» feeRate/td>td>string/td>td>true/td>td>none/td>td>Fee rate/td>/tr>tr>td>»»» webTxUrl/td>td>string/td>td>true/td>td>none/td>td>Transaction tx URL/td>/tr>tr>td>»»» tokens/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»»»» token/td>td>string/td>td>true/td>td>none/td>td>Token name/td>/tr>tr>td>»»»» tokenAddress/td>td>string/td>td>true/td>td>none/td>td>Token address/td>/tr>tr>td>»»»» decimals/td>td>integer/td>td>true/td>td>none/td>td>Token decimal point accuracy/td>/tr>tr>td>»»»» iconUrl/td>td>string/td>td>true/td>td>none/td>td>Token icon URL/td>/tr>tr>td>»»»» pullOff/td>td>bool/td>td>true/td>td>none/td>td>Enable taking down of listing, default as FALSE/td>/tr>tr>td>»»» gasLess/td>td>boolean/td>td>true/td>td>none/td>td>Enable gas free transaction/td>/tr>tr>td>» perpetualContract/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>true/td>td>none/td>td>Symbol id/td>/tr>tr>td>»» symbolDisplayName/td>td>string/td>td>true/td>td>none/td>td>Symbol display name/td>/tr>tr>td>»» settleCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Settlement asset id/td>/tr>tr>td>»» underlyingCurrencyId/td>td>string/td>td>true/td>td>none/td>td>Underlying asset id/td>/tr>tr>td>»» tickSize/td>td>string/td>td>true/td>td>none/td>td>Minimum tick size/td>/tr>tr>td>»» stepSize/td>td>string/td>td>true/td>td>none/td>td>Minimum step size/td>/tr>tr>td>»» minOrderSize/td>td>string/td>td>true/td>td>none/td>td>Minimum order size/td>/tr>tr>td>»» maxOrderSize/td>td>string/td>td>true/td>td>none/td>td>Maximum order size/td>/tr>tr>td>»» maxPositionSize/td>td>string/td>td>true/td>td>none/td>td>Maximum position size/td>/tr>tr>td>»» maxMarketPriceRange/td>td>string/td>td>true/td>td>none/td>td>Maximum Market Price rangee/td>/tr>tr>td>»» initialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Initial margin rate/td>/tr>tr>td>»» maintenanceMarginRate/td>td>string/td>td>true/td>td>none/td>td>Maintenance margin rate/td>/tr>tr>td>»» baselinePositionValue/td>td>string/td>td>true/td>td>none/td>td>Baseline position vaue/td>/tr>tr>td>»» incrementalPositionValue/td>td>string/td>td>true/td>td>none/td>td>Incremental position value/td>/tr>tr>td>»» incrementalInitialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Incremental initial margin rate/td>/tr>tr>td>»» incrementalMaintenanceMarginRate/td>td>string/td>td>true/td>td>none/td>td>Incremental maintenance margin rate/td>/tr>tr>td>»» enableTrade/td>td>boolean/td>td>true/td>td>none/td>td>Enable trade/td>/tr>tr>td>»» enableDisplay/td>td>boolean/td>td>true/td>td>none/td>td>Enable display/td>/tr>tr>td>»» enableOpenPosition/td>td>boolean/td>td>true/td>td>none/td>td>Enable open position/td>/tr>tr>td>»» digitMerge/td>td>string/td>td>true/td>td>none/td>td>Depth digit merge/td>/tr>tr>td>»» crossId/td>td>integer/td>td>true/td>td>none/td>td>Quote API use id for symbol/td>/tr>tr>td>»» crossSymbolId/td>td>integer/td>td>true/td>td>none/td>td>Quote API use symbolId for symbol/td>/tr>tr>td>»» crossSymbolName/td>td>string/td>td>true/td>td>none/td>td>Quote API use symbolName for symbol/td>/tr>tr>td>»» fundingInterestRate/td>td>string/td>td>true/td>td>none/td>td>Funding rate ratio/td>/tr>tr>td>»» fundingImpactMarginNotional/td>td>string/td>td>true/td>td>none/td>td>Not required on frontend/td>/tr>tr>td>»» displayMaxLeverage/td>td>string/td>td>true/td>td>none/td>td>Maximum leverage/td>/tr>tr>td>»» displayMinLeverage/td>td>string/td>td>true/td>td>none/td>td>Minimum leverage/td>/tr>tr>td>»» starkExSyntheticAssetId/td>td>string/td>td>true/td>td>none/td>td>Currency synthetic asset id/td>/tr>tr>td>»» starkExResolution/td>td>string/td>td>true/td>td>none/td>td>Currency resolution/td>/tr>tr>td>»» starkExRiskFactor/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» starkExOraclePriceQuorum/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-get-market-depth>GET Market Depth/h2>p>code>GET /v1/depth/code>/p>p>Retrieve all active orderbook for one symbol, inclue all bids and asks./p>h3 idpublicapi-get-market-depth-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>depth/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/depth?symbolBTCUSDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>a/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.4/span>span classp>,/span>span classw> /span>span classs2>0.071/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98743.5/span>span classp>,/span>span classw> /span>span classs2>0.035/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>b/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.3/span>span classp>,/span>span classw> /span>span classs2>0.529/span>span classw> /span>span classp>,/span>span classw> /span>span classp>/span>span classw> /span>span classs2>98742.2/span>span classp>,/span>span classw> /span>span classs2>0.178/span>span classw> /span>span classp>/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDT/span>span classp>,/span>span classw> /span>span classnl>u/span>span classp>:/span>span classw> /span>span classmi>1076833/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>timeCost/span>span classp>:/span>span classw> /span>span classmi>1056809/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-market-depth-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-market-depth-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» a/td>td>array/td>td>false/td>td>none/td>td>Sell/td>/tr>tr>td>»» b/td>td>array/td>td>false/td>td>none/td>td>Buy/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» u/td>td>integer/td>td>false/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idpublicapi-get-newest-trading-data>GET Newest Trading Data/h2>p>code>GET /v1/trades/code> /p>p>Retrieve trading data. /p>h3 idpublicapi-get-newest-trading-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit, maximum is 500/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>trades/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/trades?symbolBTCUSDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>S/span>span classp>:/span>span classw> /span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>v/span>span classp>:/span>span classw> /span>span classs2>0.001/span>span classp>,/span>span classw> /span>span classnl>p/span>span classp>:/span>span classw> /span>span classs2>29000/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>T/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-newest-trading-data-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-newest-trading-data-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» data/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» S/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» v/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» p/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» s/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» T/td>td>integer/td>td>false/td>td>none/td>td>Trade time/td>/tr>/tbody>/table>h2 idpublicapi-get-candlestick-chart-data>GET Candlestick Chart Data/h2>p>code>GET /v1/klines/code> /p>p>Retrieves all candlestick chart data.br>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W" /p>h3 idpublicapi-get-candlestick-chart-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>interval/td>td>query/td>td>string/td>td>false/td>td>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W"/td>/tr>tr>td>start/td>td>query/td>td>string/td>td>false/td>td>Start time , second timestamp/td>/tr>tr>td>end/td>td>query/td>td>string/td>td>false/td>td>End time , second timestamp/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Limit, maximum is 1500/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>klines/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>,/span>span classn>interval/span>span classo>/span>span classmi>5/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/klines?symbolBTCUSDC?interval5/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classmi>1647511440000/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>interval/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>low/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>high/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>open/span>span classp>:/span>span classw> /span>span classs2>45000/span>span classp>,/span>span classw> /span>span classnl>close/span>span classp>:/span>span classw> /span>span classs2>40000/span>span classp>,/span>span classw> /span>span classnl>volume/span>span classp>:/span>span classw> /span>span classs2>1.002/span>span classp>,/span>span classw> /span>span classnl>turnover/span>span classp>:/span>span classw> /span>span classs2>3/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-candlestick-chart-data-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-candlestick-chart-data-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» klines/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» start/td>td>integer/td>td>false/td>td>none/td>td>Start time/td>/tr>tr>td>»» symbol/td>td>string/td>td>true/td>td>none/td>td>Currency/td>/tr>tr>td>»» interval/td>td>string/td>td>true/td>td>none/td>td>Chart interval/td>/tr>tr>td>»» low/td>td>string/td>td>false/td>td>none/td>td>Low price/td>/tr>tr>td>»» high/td>td>string/td>td>false/td>td>none/td>td>High price/td>/tr>tr>td>»» open/td>td>string/td>td>false/td>td>none/td>td>Open price/td>/tr>tr>td>»» close/td>td>string/td>td>false/td>td>none/td>td>Close price/td>/tr>tr>td>»» volume/td>td>string/td>td>false/td>td>none/td>td>Trading volume/td>/tr>tr>td>»» turnover/td>td>string/td>td>false/td>td>none/td>td>Turnover/td>/tr>/tbody>/table>h2 idpublicapi-get-ticker-data>GET Ticker Data/h2>p>code>GET /v1/ticker/code> /p>p>Get the latest data on symbol tickers. /p>h3 idpublicapi-get-ticker-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>ticker/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTCUSDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/ticker?symbolBTCUSDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTCUSDC/span>span classp>,/span>span classw> /span>span classnl>price24hPcnt/span>span classp>:/span>span classw> /span>span classs2>0.450141/span>span classp>,/span>span classw> /span>span classnl>lastPrice/span>span classp>:/span>span classw> /span>span classs2>43511.50/span>span classp>,/span>span classw> /span>span classnl>highPrice24h/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>lowPrice24h/span>span classp>:/span>span classw> /span>span classs2>29996.00/span>span classp>,/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>43513.50/span>span classp>,/span>span classw> /span>span classnl>indexPrice/span>span classp>:/span>span classw> /span>span classs2>40828.94/span>span classp>,/span>span classw> /span>span classnl>openInterest/span>span classp>:/span>span classw> /span>span classs2>2036854775808/span>span classp>,/span>span classw> /span>span classnl>turnover24h/span>span classp>:/span>span classw> /span>span classs2>5626085.23749999/span>span classp>,/span>span classw> /span>span classnl>volume24h/span>span classp>:/span>span classw> /span>span classs2>169.317/span>span classp>,/span>span classw> /span>span classnl>fundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>predictedFundingRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>nextFundingTime/span>span classp>:/span>span classw> /span>span classs2>10:00:00/span>span classp>,/span>span classw> /span>span classnl>tradeCount/span>span classp>:/span>span classw> /span>span classmi>100/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-ticker-data-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-ticker-data-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» tickers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» price24hPcnt/td>td>string/td>td>false/td>td>none/td>td>24H change (%)/td>/tr>tr>td>»» lastPrice/td>td>string/td>td>false/td>td>none/td>td>Last price/td>/tr>tr>td>»» highPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H highest price/td>/tr>tr>td>»» lowPrice24h/td>td>string/td>td>false/td>td>none/td>td>24H lowest price/td>/tr>tr>td>»» oraclePrice/td>td>string/td>td>false/td>td>none/td>td>Oracle price/td>/tr>tr>td>»» indexPrice/td>td>string/td>td>false/td>td>none/td>td>Index price/td>/tr>tr>td>»» openInterest/td>td>string/td>td>false/td>td>none/td>td>Open interest/td>/tr>tr>td>»» turnover24h/td>td>string/td>td>false/td>td>none/td>td>24H turnover/td>/tr>tr>td>»» volume24h/td>td>string/td>td>false/td>td>none/td>td>24H trading volume/td>/tr>tr>td>»» fundingRate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» predictedFundingRate/td>td>string/td>td>false/td>td>none/td>td>Predicted funding rate/td>/tr>tr>td>»» nextFundingTime/td>td>string/td>td>false/td>td>none/td>td>Next funding rate/td>/tr>tr>td>»» tradeCount/td>td>string/td>td>false/td>td>none/td>td>24H trade count/td>/tr>/tbody>/table>h2 idpublicapi-get-funding-rate-history>GET Funding Rate History/h2>p>code>GET /v1/history-funding/code>/p>h3 idpublicapi-get-funding-rate-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>use code>crossSymbolName/code> responded from a href#publicapi-get-all-config-data>All Config Data/a>/td>/tr>tr>td>Limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>/tbody>/table>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_public/span> span classkn>import/span> span classn>HttpPublic/span>span classn>client/span> span classo>/span> span classn>HttpPublic/span>span classp>(/span>span classs>https://pro.apex.exchange/span>span classp>)/span>span classn>client/span>span classp>./span>span classn>history_funding/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classs2>https://pro.apex.exchange/api/v1/history-funding?symbolBTC-USDC/span> /code>/pre>/div>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyFunds/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>31297.5000008009374142/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classp>,/span>span classw> /span>span classnl>fundingTimestamp/span>span classp>:/span>span classw> /span>span classmi>12315555/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-funding-rate-history-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-funding-rate-history-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>type/th>th>required/th>th>limit/th>th>comment/th>/tr>/thead>tbody>tr>td>» historicalFunds/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» fundingTimestamp/td>td>integer/td>td>false/td>td>none/td>td>Funding timestamp/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Size/td>/tr>/tbody>/table>h2 idpublicapi-get-check-if-user-exists>GET Check If User Exists/h2>p>code>GET /v1/check-user-exist/code>/p>h3 idpublicapi-get-check-if-user-exists-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>type/th>th>required/th>th>comment/th>/tr>/thead>tbody>tr>td>ethAddress/td>td>query/td>td>string/td>td>FALSE/td>td>0x111111/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>p>success/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idpublicapi-get-check-if-user-exists-response-status-code>Response Status Code/h3>table>thead>tr>th>status code/th>th>value/th>th>comment/th>th>data model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>success/td>td>Inline/td>/tr>/tbody>/table>h3 idpublicapi-get-check-if-user-exists-response-parameters>Response Parameters/h3>p>status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h1 idprivateapi-v3-for-omni>PrivateApi V3 for Omni/h1>p>v3.0.0 /p>h2 idprivateapi-v3-for-omni-post-generate-nonce>POST Generate nonce/h2>p>code>POST /v3/generate-nonce/code>/p>p>Generate and obtain nonce before registration. The nonce is used to assemble the signature field upon registration./p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classn>priKey/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>zkKeys/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_zk_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce_v3/span>span classp>(/span>span classn>refresh/span>span classo>/span>span classs>false/span>span classp>,/span> span classn>l2Key/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span> span classn>chainId/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/generate-nonce span classnt>-X/span> POST span classnt>-d/span> span classs1>l2Key{l2Key}&ethAddress{ethAddress}&chainId{chainId}/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-generate-nonce-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» l2Key/td>td>body/td>td>string/td>td>true/td>td>User's l2Key of zkKeys/td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>true/td>td>User's Ethereum address/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>API trading users to enter "9"(NETWORKID_MAIN) on mainnet/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1123940951220551680/span>span classp>,/span>span classw> /span>span classnl>nonceExpired/span>span classp>:/span>span classw> /span>span classmi>1648727402292/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-generate-nonce-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-generate-nonce-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» nonce/td>td>string/td>td>true/td>td>none/td>td>nonce/td>/tr>tr>td>» nonceExpired/td>td>integer/td>td>true/td>td>none/td>td>The time at which nonce expires, please complete registration before this time/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-registration-amp-onboarding>POST Registration & Onboarding/h2>p>code>POST /v3/onboarding/code> /p>ol>li>Consolidate onboarding data and generate digital signature via your wallet. You can refer to python sdk, derive_zk_key for more information/li>li>Create your zkKey pair with your signature, including (seeds, l2Key, pubKeyHash）/li>li>Send consolidated onboarding data request to the server for response to user registration data, including API keys/li>/ol>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/onboarding span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-ETHEREUM-ADDRESS: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>l2Key{l2Key}&ethereumAddress{ethereumAddress}&referredByAffiliateLink{referredByAffiliateLink}&country{country}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classk>print/span>span classp>(/span>span classs>Hello, Apex Omni/span>span classp>)/span>span classn>priKey/span> span classo>/span> span classs>your eth private key/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classn>priKey/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>zkKeys/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_zk_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>zkKeys/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce_v3/span>span classp>(/span>span classn>refresh/span>span classo>/span>span classs>false/span>span classp>,/span> span classn>l2Key/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span> span classn>chainId/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>)/span>span classn>regRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>register_user_v3/span>span classp>(/span>span classn>nonce/span>span classo>/span>span classn>nonceRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>nonce/span>span classp>,/span>span classn>l2Key/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>l2Key/span>span classp>,/span> span classn>seeds/span>span classo>/span>span classn>zkKeys/span>span classp>/span>span classs>seeds/span>span classp>,/span>span classn>ethereum_address/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>changePubKeyStatus/span> span classp>(/span> span classn>INIT/span> span classc>// ini /span> span classn>REGISTERING/span> span classc>//registering (waiting for l2 execute)/span> span classn>UN_CHANGE_PUB_KEY/span> span classc>// un ChangePubKey/span> span classn>PROCESSING/span> span classc>// ChangePubKey in progress/span> span classn>FINISH/span> span classc>// ChangePubKey is finished/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-registration-amp-onboarding-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Onboarding signature/td>/tr>tr>td>APEX-ETHEREUM-ADDRESS/td>td>header/td>td>string/td>td>true/td>td>Ethereum address/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» l2Key/td>td>body/td>td>string/td>td>true/td>td>Public l2Key associated with the zkKeys you created./td>/tr>tr>td>» ethereumAddress/td>td>body/td>td>string/td>td>true/td>td>Ethereum address associated with the user being created./td>/tr>tr>td>» referredByAffiliateLink/td>td>body/td>td>string/td>td>false/td>td>Referred affiliate link/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>Country code: Must be ISO 3166-1 Alpha-2 compliant/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>apiKey/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>apiKey/span>span classp>:/span>span classw> /span>span classs2>d4fc8895-2aec-00/span>span classp>,/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classs2>d4fc8895-2aec-0025-a620/span>span classp>,/span>span classw> /span>span classnl>secret/span>span classp>:/span>span classw> /span>span classs2>l5oxJeCvjqAps/span>span classp>,/span>span classw> /span>span classnl>remark/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>ips/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0xc4C5036b68a/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>11@aa.com/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>pythonTest/span>span classp>,/span>span classw> /span>span classnl>referredByAffiliateLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>affiliateLink/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>apexTokenBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>stakedApexTokenBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isSharingUsername/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isSharingAddress/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>country/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1213724853023293440/span>span classp>,/span>span classw> /span>span classnl>avatarUrl/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>avatarBorderUrl/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>appNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>account/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0xc4c5036b68a/span>span classp>,/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>oxaaaa/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>3505225848/span>span classp>,/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classnl>spotAccount/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>zkAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>isMultiSigEthAddress/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultSubAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>1111/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>subAccounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>0x1123/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>11/span>span classp>,/span>span classw> /span>span classnl>nonceVersion/span>span classp>:/span>span classw> /span>span classmi>11/span>span classp>,/span>span classw> /span>span classnl>changePubKeyStatus/span>span classp>:/span>span classw> /span>span classs2>REGISTING/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>spotWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>12137/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191781.577364/span>span classp>,/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>experienceMoney/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>availableAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>totalNumber/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>totalAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>recycledAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>contractAccount/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>unrealizePnlPriceType/span>span classp>:/span>span classw> /span>span classs2>INDEX_PRICE/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>contractWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>121372485302/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350522584833/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191778.137753/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>isPrelaunch/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>customInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>isNewUser/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-registration-amp-onboarding-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-registration-amp-onboarding-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» apiKey/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» key/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» passphrase/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» secret/td>td>string/td>td>true/td>td>none/td>td>Used to generate signature/td>/tr>tr>td>» user/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>»» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration confirmation/td>/tr>tr>td>»» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>»» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>»» referredByAffiliateLink/td>td>string/td>td>true/td>td>none/td>td>referred Affiliate Link/td>/tr>tr>td>»» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>Email binding confirmation/td>/tr>tr>td>»» emailNotifyGeneralEnable/td>td>boolean/td>td>true/td>td>none/td>td>Newsletter, Market Updates, Product notify/td>/tr>tr>td>»» emailNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Deposits、Withdrawals, Account notify/td>/tr>tr>td>»» emailNotifyAccountEnable/td>td>boolean/td>td>true/td>td>none/td>td>Order and Liquidation notify/td>/tr>tr>td>»» popupNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Trading pop-up notify/td>/tr>tr>td>» account/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» l2Key/td>td>string/td>td>true/td>td>none/td>td>User's l2Key/td>/tr>tr>td>»» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>User's ethereumAddress/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» spotAccount/td>td>object/td>td>true/td>td>none/td>td>User's spot account/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>User's account create time/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>true/td>td>none/td>td>User's account update time/td>/tr>tr>td>»»» zkAccountId/td>td>string/td>td>true/td>td>none/td>td>User's zk account ID/td>/tr>tr>td>»»» defaultSubAccountId/td>td>string/td>td>true/td>td>none/td>td>User's zk default sub account ID/td>/tr>tr>td>»»» nonce/td>td>integer/td>td>true/td>td>none/td>td>User's account nonce/td>/tr>tr>td>»»» status/td>td>string/td>td>true/td>td>none/td>td>User's account status/td>/tr>tr>td>»»» subAccounts/td>td>object/td>td>true/td>td>none/td>td>User's sub accounts/td>/tr>tr>td>»»»» subAccountId/td>td>string/td>td>false/td>td>none/td>td>User's sub account ID/td>/tr>tr>td>»»»» l2Key/td>td>string/td>td>false/td>td>none/td>td>User's sub account l2Key/td>/tr>tr>td>»»»» nonce/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce/td>/tr>tr>td>»»»» nonceVersion/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce version/td>/tr>tr>td>»»»» changePubKeyStatus/td>td>string/td>td>false/td>td>none/td>td>User's sub account change pubKey status/td>/tr>tr>td>»» spotWallets/td>td>object/td>td>true/td>td>none/td>td>User's spot wallets/td>/tr>tr>td>»»» tokenId/td>td>string/td>td>false/td>td>none/td>td>Spot token ID/td>/tr>tr>td>»»» pendingDepositAmount/td>td>string/td>td>false/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»»» pendingWithdrawAmount/td>td>string/td>td>false/td>td>none/td>td>Pending withdraw amount/td>/tr>tr>td>»»» pendingTransferOutAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer out amount/td>/tr>tr>td>»»» pendingTransferInAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer in amount/td>/tr>tr>td>»» experienceMoney/td>td>object/td>td>true/td>td>none/td>td>Experience money/td>/tr>tr>td>»»» availableAmount/td>td>string/td>td>false/td>td>none/td>td>Available experience money amount/td>/tr>tr>td>»»» totalNumber/td>td>string/td>td>false/td>td>none/td>td>Total experience money number/td>/tr>tr>td>»»» totalAmount/td>td>string/td>td>false/td>td>none/td>td>Total experience money value/td>/tr>tr>td>»»» recycledAmount/td>td>string/td>td>false/td>td>none/td>td>Recycled experience money value/td>/tr>tr>td>»» contractAccount/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»»» minInitialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Min Initial Margin Rate/td>/tr>tr>td>»»» status/td>td>string/td>td>false/td>td>none/td>td>Account status/td>/tr>tr>td>»» contractWallets/td>td>object/td>td>true/td>td>none/td>td>Contract wallets/td>/tr>tr>td>»»» token/td>td>string/td>td>false/td>td>none/td>td>Asset token/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-retrieve-user-data>GET Retrieve User Data/h2>p>code>GET /v3/user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_v3/span> span classkn>import/span> span classn>HttpPrivate_v3/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classk>print/span>span classp>(/span>span classs>Hello, Apex Omni/span>span classp>)/span>span classc1># need api_key_credentials{key: key,secret: secret, passphrase: passphrase} for private api/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_user_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-retrieve-user-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-edit-user-data>POST Edit User Data/h2>p>code>POST /v3/modify-user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/modify-user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>userData{userData}&email{email}&username{username}&isSharingUsername{isSharingUsername}&isSharingAddress{isSharingAddress}&country{country}&emailNotifyGeneralEnable{emailNotifyGeneralEnable}&emailNotifyTradingEnable{emailNotifyTradingEnable}&emailNotifyAccountEnable{emailNotifyAccountEnable}&popupNotifyTradingEnable{popupNotifyTradingEnable}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_v3/span> span classkn>import/span> span classn>HttpPrivate_v3/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span>span classn>NETWORKID_MAIN/span>span classc1># need api_key_credentials{key: key,secret: secret, passphrase: passphrase} for private api/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_user_v3/span>span classp>()/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>modify_user_v3/span>span classp>(/span>span classn>username/span>span classo>/span>span classs>pythonTest/span>span classp>,/span>span classn>email/span>span classo>/span>span classs>11@aa.com/span>span classp>,/span>span classn>emailNotifyGeneralEnable/span>span classo>/span>span classs>true/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-edit-user-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» userData/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» email/td>td>body/td>td>string/td>td>false/td>td>Email/td>/tr>tr>td>» username/td>td>body/td>td>string/td>td>false/td>td>Username/td>/tr>tr>td>» isSharingUsername/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» isSharingAddress/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>country/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>body/td>td>string/td>td>false/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>body/td>td>string/td>td>false/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Enable trading notifications/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-edit-user-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-edit-user-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-retrieve-user-account-data>GET Retrieve User Account Data/h2>p>code>GET /v3/account/code>/p>p>Get an account for a user by id. Using the client, the id will be generated with client information and an Ethereum address./p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/account span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_v3/span> span classkn>import/span> span classn>HttpPrivate_v3/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span>span classn>NETWORKID_MAIN/span>span classc1># need api_key_credentials{key: key,secret: secret, passphrase: passphrase} for private api/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0xc4c5036b68a/span>span classp>,/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>oxaaaa/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>3505225848/span>span classp>,/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classnl>spotAccount/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>zkAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>isMultiSigEthAddress/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>defaultSubAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>1111/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>subAccounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>3505225848111/span>span classp>,/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>0x1123/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>11/span>span classp>,/span>span classw> /span>span classnl>nonceVersion/span>span classp>:/span>span classw> /span>span classmi>11/span>span classp>,/span>span classw> /span>span classnl>changePubKeyStatus/span>span classp>:/span>span classw> /span>span classs2>REGISTING/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>spotWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>12137/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191781.577364/span>span classp>,/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>experienceMoney/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>availableAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>totalNumber/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>totalAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>recycledAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>contractAccount/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>unrealizePnlPriceType/span>span classp>:/span>span classw> /span>span classs2>INDEX_PRICE/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>contractWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>121372485302/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350522584833/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191778.137753/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>isPrelaunch/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>customInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>isNewUser/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» account/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» l2Key/td>td>string/td>td>true/td>td>none/td>td>User's l2Key/td>/tr>tr>td>»» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>User's ethereumAddress/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» spotAccount/td>td>object/td>td>true/td>td>none/td>td>User's spot account/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>User's account create time/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>true/td>td>none/td>td>User's account update time/td>/tr>tr>td>»»» zkAccountId/td>td>string/td>td>true/td>td>none/td>td>User's zk account ID/td>/tr>tr>td>»»» defaultSubAccountId/td>td>string/td>td>true/td>td>none/td>td>User's zk default sub account ID/td>/tr>tr>td>»»» nonce/td>td>integer/td>td>true/td>td>none/td>td>User's account nonce/td>/tr>tr>td>»»» status/td>td>string/td>td>true/td>td>none/td>td>User's account status/td>/tr>tr>td>»»» subAccounts/td>td>object/td>td>true/td>td>none/td>td>User's sub accounts/td>/tr>tr>td>»»»» subAccountId/td>td>string/td>td>false/td>td>none/td>td>User's sub account ID/td>/tr>tr>td>»»»» l2Key/td>td>string/td>td>false/td>td>none/td>td>User's sub account l2Key/td>/tr>tr>td>»»»» nonce/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce/td>/tr>tr>td>»»»» nonceVersion/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce version/td>/tr>tr>td>»»»» changePubKeyStatus/td>td>string/td>td>false/td>td>none/td>td>User's sub account change pubKey status/td>/tr>tr>td>»» spotWallets/td>td>object/td>td>true/td>td>none/td>td>User's spot wallets/td>/tr>tr>td>»»» tokenId/td>td>string/td>td>false/td>td>none/td>td>Spot token ID/td>/tr>tr>td>»»» pendingDepositAmount/td>td>string/td>td>false/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»»» pendingWithdrawAmount/td>td>string/td>td>false/td>td>none/td>td>Pending withdraw amount/td>/tr>tr>td>»»» pendingTransferOutAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer out amount/td>/tr>tr>td>»»» pendingTransferInAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer in amount/td>/tr>tr>td>»» experienceMoney/td>td>object/td>td>true/td>td>none/td>td>Experience money/td>/tr>tr>td>»»» availableAmount/td>td>string/td>td>false/td>td>none/td>td>Available experience money amount/td>/tr>tr>td>»»» totalNumber/td>td>string/td>td>false/td>td>none/td>td>Total number/td>/tr>tr>td>»»» totalAmount/td>td>string/td>td>false/td>td>none/td>td>Total value/td>/tr>tr>td>»»» recycledAmount/td>td>string/td>td>false/td>td>none/td>td>Recycled value/td>/tr>tr>td>»» contractAccount/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»»» minInitialMarginRate/td>td>string/td>td>true/td>td>none/td>td>Min initial margin rate/td>/tr>tr>td>»»» status/td>td>string/td>td>false/td>td>none/td>td>Account status/td>/tr>tr>td>»» contractWallets/td>td>object/td>td>true/td>td>none/td>td>Contract wallets/td>/tr>tr>td>»»» asset/td>td>string/td>td>false/td>td>none/td>td>Asset/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-retrieve-user-account-balance>GET Retrieve User Account balance/h2>p>code>GET /v3/account-balance/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/account-balance span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_v3/span> span classkn>import/span> span classn>HttpPrivate_v3/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span>span classn>NETWORKID_MAIN/span>span classc1># need api_key_credentials{key: key,secret: secret, passphrase: passphrase} for private api/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_balance_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-balance-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>totalEquityValue/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>availableBalance/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>initialMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>maintenanceMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>symbolToOraclePrice/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>BTC-USDT/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>20000/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>124566/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-balance-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-retrieve-user-account-balance-response-parameters>Response Parameters/h3>p>Status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» totalEquityValue/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» availableBalance/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» initialMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» maintenanceMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» symbolToOraclePrice/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» BTC-USDC/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» oraclePrice/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» createdTime/td>td>integer/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-retrieve-user-deposit-and-withdraw-data>GET Retrieve User Deposit and Withdraw Data/h2>p>code>GET /v3/transfers/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/transfers?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&currencyIdspan classo>{/span>currencyIdspan classo>}/span>&chainIdsspan classo>{/span>chainIdsspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_v3/span> span classkn>import/span> span classn>HttpPrivate_v3/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span>span classn>NETWORKID_MAIN/span>span classc1># need api_key_credentials{key: key,secret: secret, passphrase: passphrase} for private api/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>transfersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>transfers_v3/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>currencyId/span>span classo>/span>span classs>USDT/span>span classp>,/span>span classn>chainIds/span>span classo>/span>span classs>1,5,13/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>direction/span> span classp>(/span>span classn>NEXT/span> span classn>PREVIOUS/span> span classp>)/span>span classn>TransfersType/span> span classp>(/span>span classn>DEPOSIT/span> span classn>WITHDRAW/span> span classn>FAST_WITHDRAW/span> span classn>OMNI_TO_PERP/span> span classc>//spot account -> contract account/span>span classn>OMNI_FROM_PERP/span> span classc>//spot account <- contract account/span>span classn>AFFILIATE_REBATE/span> span classc>// affliate rebate/span>span classn>REFERRAL_REBATE/span> span classc>// referral rebate/span>span classn>BROKER_REBATE/span> span classc>// broker rebate/span>span classp>)/span>span classn>Deposit/span> span classn>Status/span>span classp>{/span>span classn>PENDING_RISK_CHECKING/span> span classc>// risk checking/span>span classn>PENDING_SEND_L2/span> span classc>// sending to l2/span>span classn>SUCCESS/span> span classc>// deposit success/span>span classn>SUCCESS_L2_APPROVED/span> span classc>// L2 approved success/span>span classn>FAILED_RISK_CHECKING/span> span classc>// risk checking failed/span>span classn>FAILED_SEND_L2/span> span classc>// sending to l2 failed/span>span classn>FAILED_L2_REJECTED/span> span classc>// l2 rejected/span>span classp>}/span>span classn>Withdrawal/span> span classn>and/span> span classn>FastWithdrawal/span> span classn>Status/span>span classp>{/span>span classn>PENDING_WITHDRAW_L1_TRY/span> span classc>// pending withdraw/span>span classn>PENDING_SEND_L2/span> span classc>// pending send/span>span classn>SUCCESS/span> span classc>// withdraw success /span>span classn>SUCCESS_L2_APPROVED/span> span classc>// l2 approve withdraw success/span>span classn>WITHDRAW_CAN_BE_CLAIM/span> span classc>//the withdrawal can be claim/span>span classn>PENDING_L1_CLAIMING/span> span classc>//pengding claim/span>span classn>SUCCESS_L1_CLAIMED/span> span classc>//claim success/span>span classn>FAILED_WITHDRAW_L1_TRY_REJECTED/span> span classc>// withdraw to l1 be rejected/span>span classn>FAILED_SEND_L2/span> span classc>// withdraw failed/span>span classn>FAILED_L2_REJECTED/span> span classc>// withdraw failed by l2 /span>span classn>FAST_WITHDRAW_L1_SUCCESS/span> span classc>// fast withdraw success /span>span classn>FAILED_L1_CLAIMED_REJECTED/span> span classc>//claim failed/span>span classp>}/span>span classn>TransferStatus/span> span classp>(/span>span classn>PENDING_CHECKING/span> span classc>// transfer checking/span>span classn>PENDING_SEND_L2/span> span classc>// sending to l2/span>span classn>SUCCESS/span> span classc>// transfer success/span>span classn>SUCCESS_L2_APPROVED/span> span classc>// l2 approved/span>span classn>FAILED_CHECK_INVALID/span> span classc>// transfer check failed/span>span classn>FAILED_SEND_L2/span> span classc>// transfer send failed/span>span classn>FAILED_L2_REJECTED/span> span classc>// l2 rejected/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-deposit-and-withdraw-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameters/th>th>Position/th>th>Type/th>th>Required/th>th>Comments/th>/tr>/thead>tbody>tr>td>limit/td>td>query/td>td>integer/td>td>false/td>td>Page limit default at 100/td>/tr>tr>td>id/td>td>query/td>td>string/td>td>no/td>td>if direction is NEXT the id is the last one of this page, or direction is PREVIOUS the id is first one of this page/td>/tr>tr>td>tokenId/td>td>query/td>td>string/td>td>no/td>td>Filter to show only token ID, all will be searched if the field is empty/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>integer/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>chainIds/td>td>query/td>td>string/td>td>false/td>td>Check for multiple chainID records, separated by commas/td>/tr>tr>td>transferType/td>td>query/td>td>string/td>td>false/td>td>Check for multiple transferType records, separated by commas/td>/tr>tr>td>subAccountId/td>td>query/td>td>string/td>td>yes/td>td>none, default 0/td>/tr>tr>td>direction/td>td>query/td>td>string/td>td>no/td>td>default NEXT/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1111/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classp>,/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classw> /span>span classs2>0x12aaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>fromTokenId/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classnl>toTokenId/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>1235/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>1235/span>span classp>,/span>span classw> /span>span classnl>ethAddress/span>span classp>:/span>span classw> /span>span classs2>0x1235/span>span classp>,/span>span classw> /span>span classnl>fromEthAddress/span>span classp>:/span>span classw> /span>span classs2>0x1235/span>span classp>,/span>span classw> /span>span classnl>toEthAddress/span>span classp>:/span>span classw> /span>span classs2>0x1235/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>11/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-retrieve-user-deposit-and-withdraw-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-retrieve-user-deposit-and-withdraw-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» transfers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>DEPOSIT, WITHDRAW or FAST_WITHDRAW/td>/tr>tr>td>»» Amount/td>td>string/td>td>false/td>td>none/td>td>Amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>false/td>td>none/td>td>Transaction hash/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Status/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» updatedAt/td>td>string/td>td>false/td>td>none/td>td>Only applicable for deposits/td>/tr>tr>td>»» clientId/td>td>string/td>td>false/td>td>none/td>td>Client to create a randomized id (only for withdrawal)/td>/tr>tr>td>»» orderId/td>td>string/td>td>true/td>td>none/td>td>Success Wallet Transaction Id/td>/tr>tr>td>»» chainId/td>td>string/td>td>true/td>td>none/td>td>Supported chainId/td>/tr>tr>td>»» fee/td>td>string/td>td>true/td>td>none/td>td>Fee/td>/tr>tr>td>» totalSize/td>td>string/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-user-transfer-asset-from-fund-account-to-contract-account>POST User transfer asset from fund account to contract account/h2>p>POST /v3/transfer-out/p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_sign/span> span classkn>import/span> span classn>HttpPrivateSign/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>NETWORKID_TEST/span>span classp>,/span> span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>NETWORKID_OMNI_TEST_BNB/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register/span>span classn>seeds/span> span classo>/span> span classs>your zk seeds from register/span>span classn>l2Key/span> span classo>/span> span classs>your l2Key seeds from register/span>span classn>client/span> span classo>/span> span classn>HttpPrivateSign/span>span classp>(/span>span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_TEST/span>span classp>,/span> span classn>zk_seeds/span>span classo>/span>span classn>seeds/span>span classp>,/span>span classn>zk_l2Key/span>span classo>/span>span classn>l2Key/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountData/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classc1>#smple3 transfer_out, from fund account to contract account#createTransferRes client.create_transfer_out_v3(amount1.1,assetUSDT)#print(createTransferRes)/span>span classn>createTransferRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_transfer_out_v3/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>0.01/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>ETH/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>createTransferRes/span>span classp>)/span>/code>/pre>/div>blockquote>p>Body Request/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>amount/span>span classpi>:/span> span classs>string/span>span classna>clientTransferId/span>span classpi>:/span> span classs>string/span>span classna>timestamp/span>span classpi>:/span> span classm>0/span>span classna>tokenId/span>span classpi>:/span> span classs>string/span>span classna>token/span>span classpi>:/span> span classs>string/span>span classna>fee/span>span classpi>:/span> span classs>string/span>span classna>signature/span>span classpi>:/span> span classs>string/span>span classna>zkAccountId/span>span classpi>:/span> span classs>string/span>span classna>nonce/span>span classpi>:/span> span classm>0/span>span classna>receiverAccountId/span>span classpi>:/span> span classs>string/span>span classna>receiverZkAccountId/span>span classpi>:/span> span classs>string/span>span classna>receiverSubAccountId/span>span classpi>:/span> span classs>string/span>span classna>receiverAddress/span>span classpi>:/span> span classs>string/span>span classna>subAccountId/span>span classpi>:/span> span classs>string/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-fund-account-to-contract-account-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>yes/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>yes/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>no/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>yes/td>td>Amount/td>/tr>tr>td>» clientTransferId/td>td>body/td>td>string/td>td>yes/td>td>Unique id of the client associated with the transfer. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» timestamp/td>td>body/td>td>integer/td>td>yes/td>td>Timestamp，sec/td>/tr>tr>td>» tokenId/td>td>body/td>td>string/td>td>yes/td>td>Asset token id/td>/tr>tr>td>» token/td>td>body/td>td>string/td>td>yes/td>td>Asset token/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>yes/td>td>Transfer fee, default is 0/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>yes/td>td>The signature for the transfer,/td>/tr>tr>td>» zkAccountId/td>td>body/td>td>string/td>td>yes/td>td>User's zk account id/td>/tr>tr>td>» nonce/td>td>body/td>td>integer/td>td>yes/td>td>User's eth address nonce/td>/tr>tr>td>» receiverAccountId/td>td>body/td>td>string/td>td>yes/td>td>Contract asset pool account id/td>/tr>tr>td>» receiverZkAccountId/td>td>body/td>td>string/td>td>yes/td>td>Contract asset pool zk account id/td>/tr>tr>td>» receiverSubAccountId/td>td>body/td>td>string/td>td>yes/td>td>Contract asset pool sub account id, default is 0/td>/tr>tr>td>» receiverAddress/td>td>body/td>td>string/td>td>yes/td>td>Contract asset pool eth address/td>/tr>tr>td>» subAccountId/td>td>body/td>td>string/td>td>yes/td>td>User's sub account id,default is 0/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>TRANSFER_OUT/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-fund-account-to-contract-account-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-fund-account-to-contract-account-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-user-transfer-asset-from-contract-account-to-fund-account>POST User transfer asset from contract account to fund account/h2>p>POST /v3/contract-transfer-out/p>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_sign/span> span classkn>import/span> span classn>HttpPrivateSign/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>NETWORKID_TEST/span>span classp>,/span> span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>NETWORKID_OMNI_TEST_BNB/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register/span>span classn>seeds/span> span classo>/span> span classs>your zk seeds from register/span>span classn>l2Key/span> span classo>/span> span classs>your l2Key seeds from register/span>span classn>client/span> span classo>/span> span classn>HttpPrivateSign/span>span classp>(/span>span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_TEST/span>span classp>,/span> span classn>zk_seeds/span>span classo>/span>span classn>seeds/span>span classp>,/span>span classn>zk_l2Key/span>span classo>/span>span classn>l2Key/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountData/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classc1>#smple4 contract transfer_out, from contract account to fund account/span>span classn>createContractTransferRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_contract_transfer_out_v3/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1.2/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span> span classn>clientId/span>span classo>/span>span classs>apexomni-518082507269-1741841574131-212072/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>createContractTransferRes/span>span classp>)/span>/code>/pre>/div>blockquote>p>Body Request/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>amount/span>span classpi>:/span> span classs>string/span>span classna>clientWithdrawId/span>span classpi>:/span> span classs>string/span>span classna>expireTime/span>span classpi>:/span> span classm>0/span>span classna>ethAddress/span>span classpi>:/span> span classs>string/span>span classna>signature/span>span classpi>:/span> span classs>string/span>span classna>token/span>span classpi>:/span> span classs>string/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-contract-account-to-fund-account-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>yes/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>yes/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>no/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>yes/td>td>Amount/td>/tr>tr>td>» clientWithdrawId/td>td>body/td>td>string/td>td>yes/td>td>Unique id of the client associated with the transfer. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expireTime/td>td>body/td>td>integer/td>td>yes/td>td>Expire time，sec/td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>yes/td>td>User's eth address/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>yes/td>td>The signature for the transfer, signed with private key./td>/tr>tr>td>» token/td>td>body/td>td>string/td>td>yes/td>td>Asset token/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>PERP_TO_ZK/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-contract-account-to-fund-account-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-user-transfer-asset-from-contract-account-to-fund-account-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-user-withdrawal>POST User Withdrawal/h2>p>`POST /v3/withdrawal/p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classp>};/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/withdrawal span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount1&clientWithdrawIdxxx&timestamp1234556&ethAddress0x123&signature0x1123&zkAccountId111&subAccountId0&l2Key0x12345&toChainId3&l2SourceTokenId140&l1TargetTokenId140&fee0&nonce1&isFastWithdrawfalse/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_sign/span> span classkn>import/span> span classn>HttpPrivateSign/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>NETWORKID_TEST/span>span classp>,/span> span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>NETWORKID_OMNI_TEST_BNB/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register/span>span classn>seeds/span> span classo>/span> span classs>your zk seeds from register/span>span classn>l2Key/span> span classo>/span> span classs>your l2Key seeds from register/span>span classn>client/span> span classo>/span> span classn>HttpPrivateSign/span>span classp>(/span>span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_TEST/span>span classp>,/span> span classn>zk_seeds/span>span classo>/span>span classn>seeds/span>span classp>,/span>span classn>zk_l2Key/span>span classo>/span>span classn>l2Key/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountData/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal_v3/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>3/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span> span classn>toChainId/span>span classo>/span>span classn>NETWORKID_OMNI_TEST_BNB/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>createWithdrawRes/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-withdrawal-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>yes/td>td>Amount/td>/tr>tr>td>» clientWithdrawId/td>td>body/td>td>string/td>td>yes/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» timestamp/td>td>body/td>td>integer/td>td>yes/td>td>Timestamp，sec/td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>yes/td>td>EthAddress/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>yes/td>td>The signature for the withdraw, signed with zkKeys./td>/tr>tr>td>» zkAccountId/td>td>body/td>td>string/td>td>yes/td>td>The user's zkAccountId/td>/tr>tr>td>» subAccountId/td>td>body/td>td>string/td>td>yes/td>td>The user's subAccountId, default is 0/td>/tr>tr>td>» l2Key/td>td>body/td>td>string/td>td>yes/td>td>Zk l2Key/td>/tr>tr>td>» toChainId/td>td>body/td>td>string/td>td>yes/td>td>To chainId/td>/tr>tr>td>» l2SourceTokenId/td>td>body/td>td>string/td>td>yes/td>td>Default is 140,(USDT)/td>/tr>tr>td>» l1TargetTokenId/td>td>body/td>td>string/td>td>yes/td>td>Default is 140,(USDT)/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>yes/td>td>Default is 0/td>/tr>tr>td>» nonce/td>td>body/td>td>integer/td>td>yes/td>td>The user zk account nonce/td>/tr>tr>td>» isFastWithdraw/td>td>body/td>td>string/td>td>yes/td>td>Defalut is false/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-withdrawal-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-user-withdrawal-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>id/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>type/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-withdrawal-fees>GET Withdrawal Fees/h2>ul>li>the withdrawal need zkAvailableAmount > withdrawAmountbr>/li>li>the fast withdrawal needzkAvailableAmount > withdrawAmount && fastPoolAvailableAmount> withdrawAmountbr>/li>/ul>p>`GET /v3/withdraw-fee/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/withdraw-fee?amountspan classo>{/span>amountspan classo>}/span>&chainIdspan classo>{/span>chainIdspan classo>}/span>&tokenIdspan classo>{/span>tokenIdspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_sign/span> span classkn>import/span> span classn>HttpPrivateSign/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>NETWORKID_TEST/span>span classp>,/span> span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>NETWORKID_OMNI_TEST_BNB/span>span classn>key/span> span classo>/span> span classs>your apiKey-key from register/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register/span>span classn>seeds/span> span classo>/span> span classs>your zk seeds from register/span>span classn>l2Key/span> span classo>/span> span classs>your l2Key seeds from register/span>span classn>client/span> span classo>/span> span classn>HttpPrivateSign/span>span classp>(/span>span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_TEST/span>span classp>,/span> span classn>zk_seeds/span>span classo>/span>span classn>seeds/span>span classp>,/span>span classn>zk_l2Key/span>span classo>/span>span classn>l2Key/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountData/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>withdraw_feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>withdraw_fee_v3/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>3/span>span classp>,/span>span classn>chainIds/span>span classo>/span>span classs>3/span>span classp>,/span>span classn>tokenId/span>span classo>/span>span classs>140/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>withdraw_feeRes/span>span classp>)/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal_v3/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>3/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span> span classn>toChainId/span>span classo>/span>span classmi>3/span>span classp>,/span> span classn>fee/span>span classo>/span>span classn>withdraw_feeRes/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>data/span>span classp>)./span>span classn>get/span>span classp>(/span>span classs>withdrawFeeAndPoolBalances/span>span classp>)/span>span classmi>0/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>fee/span>span classp>),/span> span classn>isFastWithdraw/span>span classo>/span>span classbp>True/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>createWithdrawRes/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-withdrawal-fees-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>amount/td>td>query/td>td>string/td>td>false/td>td>USDT/td>/tr>tr>td>chainIds/td>td>query/td>td>string/td>td>false/td>td>withdraw to chainId/td>/tr>tr>td>tokenId/td>td>query/td>td>string/td>td>false/td>td>default is 140(USDT)/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>withdrawFeeAndPoolBalances/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classnl>tokenId/span>span classp>:/span>span classw> /span>span classs2>111/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>1.1/span>span classp>,/span>span classw> /span>span classnl>zkAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>1.1/span>span classp>,/span>span classw> /span>span classnl>fastpoolAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>1.1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-withdrawal-fees-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-withdrawal-fees-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» withdrawFeeAndPoolBalances/td>td>object/td>td>true/td>td>none/td>td>Fee and Pool/td>/tr>tr>td>»» chainId/td>td>string/td>td>true/td>td>none/td>td>ChainId/td>/tr>tr>td>»» zklinkTokenId/td>td>string/td>td>true/td>td>none/td>td>TokenId/td>/tr>tr>td>»» fee/td>td>string/td>td>true/td>td>none/td>td>Fee/td>/tr>tr>td>»» zklinkAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Pool zklink available amount/td>/tr>tr>td>»» fastpoolAvailableAmount/td>td>string/td>td>false/td>td>none/td>td>Fast pool available amount/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-contract-account-transfer-limits>GET Contract Account Transfer Limits/h2>p>code>GET /v3/contract-transfer-limit/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/contract-transfer-limit?tokenspan classo>{/span>tokenspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>contract_transfer_limit_v3/span>span classp>(/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>accountRes/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>accountRes/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-contract-account-transfer-limits-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>withdrawAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>transferAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyRecycledAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>withdrawAvailableOriginAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>experienceMoneyNeedRecycleAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-contract-account-transfer-limits-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-contract-account-transfer-limits-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» withdrawAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Withdraw available amount/td>/tr>tr>td>» transferAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Transfer available amount/td>/tr>tr>td>» experienceMoneyAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Experience money available amount/td>/tr>tr>td>» experienceMoneyRecycledAmount/td>td>string/td>td>true/td>td>none/td>td>Experience money recycled amount/td>/tr>tr>td>» withdrawAvailableOriginAmount/td>td>string/td>td>true/td>td>none/td>td>Withdraw available origin amount/td>/tr>tr>td>» experienceMoneyNeedRecycleAmount/td>td>string/td>td>true/td>td>none/td>td>Experience money need recycle amount/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-trade-history>GET Trade History/h2>p>code>GET /v3/fills/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/fills?limitspan classo>/span>100&pagespan classo>/span>0&symbolspan classo>/span>BTC-USDC&sidespan classo>/span>BUY span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>fillsRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>fills_v3/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classn>Type/span> span classs>UNKNOWN_ORDER_TYPE/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-trade-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>orderType/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>123546/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-trade-history-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-trade-history-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total order size/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-worst-price>GET Worst Price/h2>p>code>GET /v3/get-worst-price/code>/p>p>get market price from orderbook /p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/get-worst-price?sizespan classo>/span>1&symbolspan classo>/span>BTC-USDT&sidespan classo>/span>BUY span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>fillsRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_worst_price_v3/span>span classp>(/span>span classn>size/span>span classo>/span>span classmi>1/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-worst-price-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>size/td>td>query/td>td>string/td>td>true/td>td>Order open size/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>true/td>td>BUY or SELL order/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>worstPrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>bidOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>askOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-worst-price-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-worst-price-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» worstPrice/td>td>string/td>td>true/td>td>none/td>td>Lowest price/td>/tr>tr>td>» bidOnePrice/td>td>string/td>td>true/td>td>none/td>td>Bid price/td>/tr>tr>td>» askOnePrice/td>td>string/td>td>true/td>td>none/td>td>Ask price/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-creating-orders>POST Creating Orders/h2>p>code>POST /v3/order/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>TimeInForce/span> span classp>(/span> span classn>GOOD_TIL_CANCEL/span> span classc>// Effective until canceled, default. /span>span classn>FILL_OR_KILL/span> span classc>// Immediately and completely filled or canceled. /span>span classn>IMMEDIATE_OR_CANCEL/span> span classc>// Immediately executed or canceled. /span>span classp>)/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{symbol}&side{side}&type{type}&size{size}&price{price}&limitFee{limitFee}&expiration{expiration}&timeInForce{timeInForce}&triggerPrice{triggerPrice}&trailingPercent{trailingPercent}&clientOrderId{clientOrderId}&signature{signature}&reduceOnlyfalse/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register/span>span classn>seeds/span> span classo>/span> span classs>your zk seeds from register/span>span classn>l2Key/span> span classo>/span> span classs>your l2Key seeds from register/span>span classn>client/span> span classo>/span> span classn>HttpPrivateSign/span>span classp>(/span>span classn>APEX_OMNI_HTTP_TEST/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_TEST/span>span classp>,/span> span classn>zk_seeds/span>span classo>/span>span classn>seeds/span>span classp>,/span>span classn>zk_l2Key/span>span classo>/span>span classn>l2Key/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountData/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_order_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span> span classn>side/span>span classo>/span>span classs>SELL/span>span classp>,/span> span classnb>type/span>span classo>/span>span classs>MARKET/span>span classp>,/span> span classn>size/span>span classo>/span>span classs>0.001/span>span classp>,/span> span classn>timestampSeconds/span>span classo>/span> span classn>currentTime/span>span classp>,/span> span classn>price/span>span classo>/span>span classs>60000/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>createOrderRes/span>span classp>)/span>span classc1># sample6# Create a TP/SL order# first, Set a slippage to get an acceptable slPrice or tpPrice#slippage is recommended to be greater than 0.1# when buying, the price price*(1 + slippage). when selling, the price price*(1 - slippage)/span>span classn>slippage/span> span classo>/span> span classn>decimal/span>span classp>./span>span classn>Decimal/span>span classp>(/span>span classs>-0.1/span>span classp>)/span>span classn>slPrice/span> span classo>/span> span classn>decimal/span>span classp>./span>span classn>Decimal/span>span classp>(/span>span classs>58000/span>span classp>)/span> span classo>*/span> span classp>(/span>span classn>decimal/span>span classp>./span>span classn>Decimal/span>span classp>(/span>span classs>1/span>span classp>)/span> span classo>+/span> span classn>slippage/span>span classp>)/span>span classn>tpPrice/span> span classo>/span> span classn>decimal/span>span classp>./span>span classn>Decimal/span>span classp>(/span>span classs>79000/span>span classp>)/span> span classo>*/span> span classp>(/span>span classn>decimal/span>span classp>./span>span classn>Decimal/span>span classp>(/span>span classs>1/span>span classp>)/span> span classo>-/span> span classn>slippage/span>span classp>)/span>span classn>createOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_order_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span> span classn>side/span>span classo>/span>span classs>BUY/span>span classp>,/span> span classnb>type/span>span classo>/span>span classs>LIMIT/span>span classp>,/span> span classn>size/span>span classo>/span>span classs>0.01/span>span classp>,/span> span classn>price/span>span classo>/span>span classs>65000/span>span classp>,/span> span classn>isOpenTpslOrder/span>span classo>/span>span classbp>True/span>span classp>,/span> span classn>isSetOpenSl/span>span classo>/span>span classbp>True/span>span classp>,/span> span classn>slPrice/span>span classo>/span>span classn>slPrice/span>span classp>,/span> span classn>slSide/span>span classo>/span>span classs>SELL/span>span classp>,/span> span classn>slSize/span>span classo>/span>span classs>0.01/span>span classp>,/span> span classn>slTriggerPrice/span>span classo>/span>span classs>58000/span>span classp>,/span> span classn>isSetOpenTp/span>span classo>/span>span classbp>True/span>span classp>,/span> span classn>tpPrice/span>span classo>/span>span classn>tpPrice/span>span classp>,/span> span classn>tpSide/span>span classo>/span>span classs>SELL/span>span classp>,/span> span classn>tpSize/span>span classo>/span>span classs>0.01/span>span classp>,/span> span classn>tpTriggerPrice/span>span classo>/span>span classs>79000/span>span classp>,/span> span classp>)/span>span classk>print/span>span classp>(/span>span classn>createOrderRes/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-creating-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>» side/td>td>body/td>td>string/td>td>true/td>td>BUY or SELL/td>/tr>tr>td>» type/td>td>body/td>td>string/td>td>true/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT", "TAKE_PROFIT_MARKET"/td>/tr>tr>td>» size/td>td>body/td>td>string/td>td>true/td>td>Size/td>/tr>tr>td>» price/td>td>body/td>td>string/td>td>true/td>td>Price/td>/tr>tr>td>» limitFee/td>td>body/td>td>string/td>td>true/td>td>limitFee price * size * takerFeeRate( from GET /v1/account)/td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Order expiry time/td>/tr>tr>td>» timeInForce/td>td>body/td>td>string/td>td>false/td>td>"GOOD_TIL_CANCEL", "FILL_OR_KILL", "IMMEDIATE_OR_CANCEL", "POST_ONLY"/td>/tr>tr>td>» triggerPrice/td>td>body/td>td>string/td>td>false/td>td>Trigger price/td>/tr>tr>td>» trailingPercent/td>td>body/td>td>string/td>td>false/td>td>Conditional order trailing-stop/td>/tr>tr>td>» clientOrderId/td>td>body/td>td>string/td>td>true/td>td>Randomized client id/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>zkKey signature/td>/tr>tr>td>» reduceOnly/td>td>body/td>td>string/td>td>false/td>td>Reduce-only/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>stopPnl/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>INDEX/span>span classp>,/span>span classw> /span>span classnl>isOpenTpslOrder/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isSetOpenTp/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isSetOpenSl/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>openTpParam/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>111100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>openSlParam/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>111100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-creating-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-creating-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-cancel-order>POST Cancel Order/h2>p>code>POST /v3/delete-order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/delete-order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order_v3/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-order-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-order-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-cancel-order-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-cancel-order-by-clientorderid>POST Cancel Order By ClientOrderId/h2>p>code>POST /v3/delete-client-order-id/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/delete-client-order-idspan classsb>`/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order_by_client_order_id_v3/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-order-by-clientorderid-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-order-by-clientorderid-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-cancel-order-by-clientorderid-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-open-orders>GET Open Orders/h2>p>code>GET /v3/open-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>openOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>open_orders_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-open-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-open-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-open-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-cancel-all-open-orders>POST Cancel all Open Orders/h2>p>code>POST /v3/delete-open-orders/code>/p>blockquote>p>Body Request Parameters/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>BTC-USDT,ETH-USDT/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/delete-open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{BTC-USDC,ETH-USDC}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>deleteOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_open_orders_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT,ETH-USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-all-open-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>false/td>td>"BTC-USDT,ETH-USDT", Cancel all orders if none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-cancel-all-open-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-cancel-all-open-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>h2 idprivateapi-v3-for-omni-get-all-order-history>GET All Order History/h2>p>code>GET /v3/history-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/history-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>historyOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_orders_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-all-order-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT","TAKE_PROFIT_MARKET"/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>"ACTIVE","CONDITION","HISTORY"/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-all-order-history-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-all-order-history-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>total order size/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-order-id>GET Order ID/h2>p>code>GET /v3/order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/order?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order_v3/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-order-id-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-order-id-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-order-id-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-order-by-clientorderid>GET Order by clientOrderId/h2>p>code>GET /v3/order-by-client-order-id"/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/order-by-client-order-id?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order_by_client_order_id_v3/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-order-by-clientorderid-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-order-by-clientorderid-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-order-by-clientorderid-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-funding-rate>GET Funding Rate/h2>p>code>GET /v3/funding/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/funding?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span>&sidespan classo>{/span>sidespan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>fundingRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>funding_v3/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-funding-rate-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>Side/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>Order status/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fundingValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>fundingValue/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>positionSize/span>span classp>:/span>span classw> /span>span classs2>500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>90/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>transactionId/span>span classp>:/span>span classw> /span>span classs2>1234556/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-funding-rate-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-funding-rate-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» fundingValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>id/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» fundingValue/td>td>string/td>td>false/td>td>none/td>td>Funding fee value/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» positionSize/td>td>string/td>td>false/td>td>none/td>td>Open position size/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Symbol price/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Position side/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Position funding status/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Funding fee time/td>/tr>tr>td>»» transactionId/td>td>string/td>td>false/td>td>none/td>td>Successful wallet transaction ID/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-user-historial-profit-and-loss>GET User Historial Profit and Loss/h2>p>code>GET /v3/historical-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/historical-pnl?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&beginTimeInclusivespan classo>{/span>beginTimeInclusivespan classo>}/span>&endTimeExclusivespan classo>{/span>endTimeExclusivespan classo>}/span>&typespan classo>{/span>span classnb>type/span>span classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>historicalPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>historical_pnl_v3/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>beginTimeInclusive/span>span classo>/span>span classmi>1651406864000/span>span classp>,/span>span classn>endTimeExclusive/span>span classo>/span>span classmi>1657105971171/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-user-historial-profit-and-loss-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>StartTime/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>EndTime/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>Position type/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historicalPnl/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>totalPnl/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CLOSE_POSITION/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-user-historial-profit-and-loss-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-user-historial-profit-and-loss-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historicalPnl/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» totalPnl/td>td>string/td>td>false/td>td>none/td>td>Closing profit and loss/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» exitPrice/td>td>string/td>td>false/td>td>none/td>td>Closing price/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>postion type/td>/tr>tr>td>»» isLiquidate/td>td>boolean/td>td>false/td>td>none/td>td>Liquidate/td>/tr>tr>td>»» isDeleverage/td>td>boolean/td>td>false/td>td>none/td>td>ADL/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-yesterday-39-s-profit-amp-loss>GET Yesterday's Profit & Loss/h2>p>code>GET /v3/yesterday-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/yesterday-pnl span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>yesterdayPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>yesterday_pnl_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-yesterday-39-s-profit-amp-loss-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>11.11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-yesterday-39-s-profit-amp-loss-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-yesterday-39-s-profit-amp-loss-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Profit and loss value/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-get-historical-asset-value>GET Historical Asset Value/h2>p>code>GET /v3/history-value/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/history-value span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>historyValueRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_value_v3/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-historical-asset-value-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>endTime/td>td>query/td>td>int64/td>td>false/td>td>Start time/td>/tr>tr>td>startTime/td>td>query/td>td>int64/td>td>false/td>td>End time/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>accountTotalValue/span>span classp>:/span>span classw> /span>span classs2>123.11/span>span classp>,/span>span classw> /span>span classnl>dateTime/span>span classp>:/span>span classw> /span>span classmi>1651406864000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-historical-asset-value-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-historical-asset-value-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historyValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» accountTotalValue/td>td>string/td>td>false/td>td>none/td>td>Assets/td>/tr>tr>td>»» dateTime/td>td>integer/td>td>false/td>td>none/td>td>Assets date and time snapshot/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-sets-the-initial-margin-rate-of-a-contract>POST Sets the initial margin rate of a contract/h2>p>POST /v3/set-initial-margin-rate/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://omni.apex.exchange/api/v3/set-initial-margin-rate span classnt>-H/span> span classs2>Content-Type: application/x-www-form-urlencoded/span> span classnt>-H/span> span classs2>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs2>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs2>APEX-API-KEY: ***/span> span classnt>-H/span> span classs2>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs2>symbolBTC-USDC&initialMarginRate0.02/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classn>key/span> span classo>/span> span classs>your apiKey-key from register V3/span>span classn>secret/span> span classo>/span> span classs>your apiKey-secret from register V3/span>span classn>passphrase/span> span classo>/span> span classs>your apiKey-passphrase from register V3/span>span classn>client/span> span classo>/span> span classn>HttpPrivate_v3/span>span classp>(/span>span classn>APEX_OMNI_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_OMNI_MAIN_ARB/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v3/span>span classp>()/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_v3/span>span classp>()/span>span classn>setInitialMarginRateRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>set_initial_margin_rate_v3/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span>span classn>initialMarginRate/span>span classo>/span>span classs>0.1/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>setInitialMarginRateRes/span>span classp>)/span>/code>/pre>/div>blockquote>p>Body /p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>string/span>span classna>initialMarginRate/span>span classpi>:/span> span classs>string/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-sets-the-initial-margin-rate-of-a-contract-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>symbol/td>/tr>tr>td>» initialMarginRate/td>td>body/td>td>string/td>td>true/td>td>initialMarginRate(the reciprocal of the opening leverage)/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>h3 idprivateapi-v3-for-omni-post-sets-the-initial-margin-rate-of-a-contract-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-sets-the-initial-margin-rate-of-a-contract-response-parameters>Response Parameters/h3>h2 idprivateapi-v3-for-omni-get-repayment-price-v3>GET Repayment price V3/h2>p>GET /v3/repayment-price/p>div classhighlight>pre classhighlight plaintext>code>Direction ( SPOT_TO_PRICING //Spot assets -> Priced assets (usdt) PRICING_TO_SPOT //Priced assets (usdt)->Spot assets)Status ( PENDING_CHECKING PENDING_CENSORING SUCCESS SUCCESS_L2_APPROVED FAILED_CHECK_INVALID FAILED_CENSOR_FAILURE FAILED_L2_REJECTED )/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-repayment-price-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>repaymentPriceTokens/td>td>query/td>td>string/td>td>yes/td>td>/td>/tr>tr>td>clientId/td>td>query/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>repaymentPriceTokens/span>span classpi>:/span> span classs>ETH|1,BTC|0.1/span>/code>/pre>/div>blockquote>p>Successful Response Generation /p>p>Successful/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>repaymentTokens/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>ETH/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-get-repayment-price-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-get-repayment-price-v3-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» repaymentTokens/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» token/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-v3-for-omni-post-user-manual-repayment-v3>POST User manual repayment V3/h2>p>POST /v3/manual-create-repayment/p>blockquote>p>Body /p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>repaymentTokens/span>span classpi>:/span> span classs>ETH|3000|1,BTC|60000|0.1/span>span classna>clientId/span>span classpi>:/span> span classs>string/span>span classna>signature/span>span classpi>:/span> span classs>string/span>span classna>expireTime/span>span classpi>:/span> span classm>0/span>span classna>poolRepaymentTokens/span>span classpi>:/span> span classs>ETH|3000|1,BTC|60000|0.1/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-manual-repayment-v3-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>yes/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>yes/td>td>none/td>/tr>tr>td>» repaymentTokens/td>td>body/td>td>string/td>td>yes/td>td>token/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>yes/td>td>Unique id of the client associated with the transfer. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>yes/td>td>none/td>/tr>tr>td>» expireTime/td>td>body/td>td>integer/td>td>yes/td>td>sec/td>/tr>tr>td>» poolRepaymentTokens/td>td>body/td>td>string/td>td>yes/td>td>token/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>p>Successful/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v3-for-omni-post-user-manual-repayment-v3-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v3-for-omni-post-user-manual-repayment-v3-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h1 idprivateapi-v2-for-pro>PrivateApi V2 for Pro/h1>p>v2.0 /p>h2 idprivateapi-v2-for-pro-post-generate-nonce-v2>POST Generate nonce V2/h2>p>code>POST /v2/generate-nonce/code>/p>p>Before registering, generate and obtain a nonce. The nonce serves the purpose of assembling the signature field during the registration process. /p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classs>0x*****/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v2/span>span classp>()/span>span classn>stark_key_pair_with_y_coordinate/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_stark_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce/span>span classp>(/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>5/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/generate-nonce span classnt>-X/span> POST span classnt>-d/span> span classs1>starkKey{starkKey}&ethAddress{ethAddress}&chainId{chainId}/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-generate-nonce-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» starkKey/td>td>body/td>td>string/td>td>true/td>td>User's starkKey/td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>true/td>td>User's Ethereum address/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>API trading users to enter "1" on mainnet/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1123940951220551680/span>span classp>,/span>span classw> /span>span classnl>nonceExpired/span>span classp>:/span>span classw> /span>span classmi>1648727402292/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-generate-nonce-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-generate-nonce-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» nonce/td>td>string/td>td>true/td>td>none/td>td>nonce/td>/tr>tr>td>» nonceExpired/td>td>integer/td>td>true/td>td>none/td>td>The time at which nonce expires, please complete registration before this time/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-registration-amp-onboarding-v2>POST Registration & Onboarding V2/h2>p>code>POST /v2/onboarding/code> /p>ol>li>Consolidate onboarding data and generate a digital signature using your wallet. Refer to the Python SDK, specifically derive_stark_key, for more information.br>/li>li>Create your Stark Key pair with your signature, comprising (publicKey, publicKeyYCoordinate, privateKey).br>/li>li>Send the consolidated onboarding data request to the server for a response, including API keys for user registration.br>/li>/ol>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/onboarding span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-ETHEREUM-ADDRESS: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>starkKey{starkKey}&starkKeyYCoordinate{starkKeyYCoordinate}&ethereumAddress{ethereumAddress}&referredByAffiliateLink{referredByAffiliateLink}&country{country}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classs>0xb7daaaaaaaaaaaaaaaa/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs_v2/span>span classp>()/span>span classn>stark_key_pair_with_y_coordinate/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_stark_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce/span>span classp>(/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>5/span>span classp>)/span>span classn>regRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>register_user_v2/span>span classp>(/span>span classn>nonce/span>span classo>/span>span classn>nonceRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>nonce/span>span classp>,/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key_y_coordinate/span>span classp>,/span>span classn>ethereum_address/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-registration-amp-onboarding-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Onboarding signature/td>/tr>tr>td>APEX-ETHEREUM-ADDRESS/td>td>header/td>td>string/td>td>true/td>td>Ethereum address/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» starkKey/td>td>body/td>td>string/td>td>true/td>td>Public starkKey associated with the key-pair you created./td>/tr>tr>td>» starkKeyYCoordinate/td>td>body/td>td>string/td>td>true/td>td>Public starkKey Y-Coordinate associated with the key-pair you created./td>/tr>tr>td>» ethereumAddress/td>td>body/td>td>string/td>td>true/td>td>Ethereum address associated with the user being created./td>/tr>tr>td>» referredByAffiliateLink/td>td>body/td>td>string/td>td>false/td>td>Referred affiliate link/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>Country code: Must be ISO 3166-1 Alpha-2 compliant/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>apiKey/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classs2>290xxxxxx/span>span classp>,/span>span classw> /span>span classnl>passphrase/span>span classp>:/span>span classw> /span>span classs2>S6xxxxx/span>span classp>,/span>span classw> /span>span classnl>secret/span>span classp>:/span>span classw> /span>span classs2>KQ3xxxx/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x09xxxxxx/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>man/span>span classp>,/span>span classw> /span>span classnl>referredByAffiliateLink/span>span classp>:/span>span classw> /span>span classs2>url/span>span classp>,/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>account/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>starkKey/span>span classp>:/span>span classw> /span>span classs2>180913017c740260fea4b2c62828a4008ca8b0d6e4/span>span classp>,/span>span classw> /span>span classnl>positionId/span>span classp>:/span>span classw> /span>span classs2>1812/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1812/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>experienceMoney/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>availableAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>totalNumber/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>totalAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>recycledAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>12137/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191781.577364/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>12137/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191781.577364/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>openPositions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>id/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-registration-amp-onboarding-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-registration-amp-onboarding-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» apiKey/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» key/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» passphrase/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» secret/td>td>string/td>td>true/td>td>none/td>td>Used to generate signature/td>/tr>tr>td>» user/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>»» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration confirmation/td>/tr>tr>td>»» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>»» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>»» referredByAffiliateLink/td>td>string/td>td>true/td>td>none/td>td>referred Affiliate Link/td>/tr>tr>td>»» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>Email binding confirmation/td>/tr>tr>td>»» emailNotifyGeneralEnable/td>td>boolean/td>td>true/td>td>none/td>td>Newsletter, Market Updates, Product notify/td>/tr>tr>td>»» emailNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Deposits、Withdrawals, Account notify/td>/tr>tr>td>»» emailNotifyAccountEnable/td>td>boolean/td>td>true/td>td>none/td>td>Order and Liquidation notify/td>/tr>tr>td>»» popupNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Trading pop-up notify/td>/tr>tr>td>» account/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» starkKey/td>td>string/td>td>true/td>td>none/td>td>User's starkKey/td>/tr>tr>td>»» positionId/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» experienceMoney/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» availableAmount/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» totalNumber/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» totalAmount/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» recycledAmount/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» token/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»» accounts/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»»» minInitialMarginRate/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» status/td>td>string/td>td>false/td>td>none/td>td>/td>/tr>tr>td>»»» token/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» wallets/td>td>object/td>td>true/td>td>none/td>td>User wallet/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User ID/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»»» asset/td>td>string/td>td>false/td>td>none/td>td>Asset/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-retrieve-user-data-v2>GET Retrieve User Data V2/h2>p>code>GET /v2/user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_user/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-retrieve-user-data-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-edit-user-data-v2>POST Edit User Data V2/h2>p>code>POST /v2/modify-user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/modify-user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>userData{userData}&email{email}&username{username}&isSharingUsername{isSharingUsername}&isSharingAddress{isSharingAddress}&country{country}&emailNotifyGeneralEnable{emailNotifyGeneralEnable}&emailNotifyTradingEnable{emailNotifyTradingEnable}&emailNotifyAccountEnable{emailNotifyAccountEnable}&popupNotifyTradingEnable{popupNotifyTradingEnable}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>modify_user/span>span classp>(/span>span classn>username/span>span classo>/span>span classs>pythonTest/span>span classp>,/span>span classn>email/span>span classo>/span>span classs>11@aa.com/span>span classp>,/span>span classn>emailNotifyGeneralEnable/span>span classo>/span>span classs>true/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-edit-user-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» userData/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» email/td>td>body/td>td>string/td>td>false/td>td>Email/td>/tr>tr>td>» username/td>td>body/td>td>string/td>td>false/td>td>Username/td>/tr>tr>td>» isSharingUsername/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» isSharingAddress/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>country/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>body/td>td>string/td>td>false/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>body/td>td>string/td>td>false/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Enable trading notifications/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-edit-user-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-edit-user-data-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-retrieve-user-account-data-v2>GET Retrieve User Account Data V2/h2>p>code>GET /v2/account/code>/p>p>Retrieve a user's account by their ID. Utilize the client, where the ID is generated with client information and an Ethereum address. /p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/account span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>starkKey/span>span classp>:/span>span classw> /span>span classs2>1234567/span>span classp>,/span>span classw> /span>span classnl>positionId/span>span classp>:/span>span classw> /span>span classs2>350522584833/span>span classp>,/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0xc4c5036b68a42d8f1c6ba9ba8e5dd49ad5c1ef5c/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>350522584833/span>span classp>,/span>span classw> /span>span classnl>experienceMoney/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>availableAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>totalNumber/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>totalAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>recycledAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690365436385/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00050/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00020/span>span classp>,/span>span classw> /span>span classnl>minInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>121372485302/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>350522584833/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1191778.137753/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1690366452416/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>customInitialMarginRate/span>span classp>:/span>span classw> /span>span classs2>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-data-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>»» starkKey/td>td>string/td>td>true/td>td>none/td>td>User's starkKey/td>/tr>tr>td>»» positionId/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»» wallets/td>td>object/td>td>true/td>td>none/td>td>User wallet/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User ID/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»»» asset/td>td>string/td>td>false/td>td>none/td>td>Asset/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-retrieve-user-account-balance-v2>GET Retrieve User Account balance V2/h2>p>code>GET /v2/account-balance/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/account-balance span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_balance/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-balance-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>usdtBalance/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>totalEquityValue/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>availableBalance/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>initialMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>maintenanceMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>symbolToOraclePrice/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>BTC-USDC/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>20000/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>124566/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>usdcBalance/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>totalEquityValue/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>availableBalance/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>initialMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>maintenanceMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>symbolToOraclePrice/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>BTC-USDC/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>20000/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>124566/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-balance-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-retrieve-user-account-balance-v2-response-parameters>Response Parameters/h3>p>Status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» usdtBalance/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» totalEquityValue/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» availableBalance/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» initialMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» maintenanceMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» symbolToOraclePrice/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» BTC-USDC/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»»» oraclePrice/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»»» createdTime/td>td>integer/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» usdcBalance/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» totalEquityValue/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» availableBalance/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» initialMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» maintenanceMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» symbolToOraclePrice/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» BTC-USDC/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»»» oraclePrice/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»»» createdTime/td>td>integer/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-retrieve-user-deposit-data-v2>GET Retrieve User Deposit Data V2/h2>p>code>GET /v2/transfers/code>/p>p>Please note, the currency is required to retrieve user deposit data. /p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/transfers?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&currencyIdspan classo>{/span>currencyIdspan classo>}/span>&chainIdsspan classo>{/span>chainIdsspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>transfersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>transfers_v2/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>currencyId/span>span classo>/span>span classs>USDT/span>span classp>,/span>span classn>chainIds/span>span classo>/span>span classs>1,5,13/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>Deposit/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_DEPOSIT_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_L1_CREATING/span> span classm>1/span> span classc>// Deposit pending on L1, awaiting confirmation. /span>span classn>PENDING_RISK_CHECKING/span> span classm>2/span> span classc>// Confirmed, risk check in progress. /span>span classn>PENDING_CENSORING/span> span classm>3/span> span classc>// Risk check complete, awaiting verification. /span>span classn>SUCCESS/span> span classm>4/span> span classc>// Deposit success, your funds have been sent to your wallet. Awaiting L2 validation. /span>span classn>SUCCESS_L2_APPROVED/span> span classm>5/span> span classc>// L2 approved. /span>span classn>CANCELED/span> span classm>6/span> span classc>// L1 confirmation failure, deposit has been canceled. /span>span classn>FAILED_RISK_CHECK_FAILURE/span> span classm>7/span> span classc>// Deposit has failed due to failed risk check. /span>span classn>FAILED_CENSOR_FAILURE/span> span classm>8/span> span classc>// Deposit has failed due to inaccurate data, data entries have been rolled back. /span>span classn>FAILED_L2_REJECTED/span> span classm>9/span> span classc>// Deposit has failed due to failed L2 approval. Deposited funds have been removed from your account. /span>span classp>}/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_RISK_CHECKING/span> span classm>1/span> span classc>// Risk check in progress. /span>span classn>PENDING_CENSORING/span> span classm>2/span> span classc>// Pending verification. /span>span classn>PENDING_L2_APPROVING/span> span classm>3/span> span classc>// Approved, awaiting L2 validation. /span>span classn>PENDING_L1_CONFIRMING/span> span classm>4/span> span classc>// L2 validation complete, pending L1 confirmation. /span>span classn>PENDING_L1_WITHDRAWING/span> span classm>5/span> span classc>// Withdrawal request on L1 complete, awaiting user withdrawal. /span>span classn>SUCCESS/span> span classm>6/span> span classc>// Withdrawal success, your withdrawn funds can now be found in your wallet. /span>span classn>FAILED_RISK_CHECK_FAILURE/span> span classm>7/span> span classc>// Withdrawal unsuccessful due to failed risk check. /span>span classn>FAILED_CENSOR_FAILURE/span> span classm>8/span> span classc>// Withdrawal unsuccessful due to inaccurate data, data entries have been rolled back. /span>span classn>FAILED_L2_REJECTED/span> span classm>9/span> span classc>// Withdrawal unsuccessful due to failed L2 approval and roll back has commenced. /span>span classp>}/span> span classn>Cross/span>span classo>-/span>span classn>Chain/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_CROSS_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_CROSS_WITHDRAW_CHECKING/span> span classm>1/span> span classc>// Pending chain verification. /span>span classn>SUCCESS_CROSS_WITHDRAW_SUBMIT_CENSOR/span> span classm>2/span> span classn>PENDING_CROSS_WITHDRAW__CENSOR_CHECKING_ACCOUNT/span> span classm>3/span> span classc>// /span>span classn>PENDING_CROSS_WITHDRAW_CENSORING/span> span classm>4/span> span classc>// Pending data verification. /span>span classn>PENDING_CROSS_WITHDRAW_L2_APPROVING/span> span classm>5/span> span classc>// Verification successful, awaiting L2 approval. /span>span classn>PENDING_CROSS_WITHDRAW_L1_SUBMIT/span> span classm>6/span> span classc>//Approved, submitting to L1. /span>span classn>PENDING_CROSS_WITHDRAW_L1_CONFIRMING/span> span classm>7/span> span classc>// L1 submission successful, pending L1 validation. /span>span classn>CROSS_WITHDRAW_SUCCESS/span> span classm>8/span> span classc>// Withdrawal successful. /span>span classn>FAILED_CROSS_WITHDRAW_TRANSFER_REJECTED/span> span classm>9/span> span classo>//span>span classn>Transfer/span> span classn>rejected/span>span classo>./span> span classn>FAILED_CROSS_WITHDRAW__CENSOR_CHECKING_ACCOUNT_REJECTED/span> span classm>10/span> span classc>//Account verification rejected. /span>span classn>FAILED_CROSS_WITHDRAW_CENSORING/span> span classm>11/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_CROSS_L2_REJECTED/span> span classm>12/span> span classc>// Transfer has failed. L2 validation rejection, roll back has commenced. /span>span classn>FAILED_CROSS_WITHDRAW_L1_SUBMIT_REJECTED/span> span classm>13/span> span classn>FAILED_CROSS_WITHDRAW_L1_REJECTED/span> span classm>14/span>span classc>// Withdrawal request failed, L1 transfer unsuccessful. /span>span classp>}/span> span classn>Cross/span>span classo>-/span>span classn>Chain/span> span classn>Deposit/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_CROSS_DEPOSIT_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_CROSS_DEPOSIT_L1_CREATING/span> span classm>1/span> span classc>// Deposit confirmed on L1, creating transaction. /span>span classn>PENDING_CROSS_DEPOSIT_L2_TRIGGER/span> span classm>2/span> span classc>// Awaiting trigger for transfer to L2. /span>span classn>PENDING_CROSS_DEPOSIT_CENSOR_CHECKING/span> span classm>3/span> span classc>// L1 deposit successful, awaiting transfer to L2. /span>span classn>SUCCESS_CROSS_DEPOSIT_SUBMIT_CENSOR/span> span classm>4/span> span classn>PENDING_CROSS_DEPOSIT_CENSOR_CHECKING_ACCOUNT/span> span classm>5/span> span classc>// /span>span classn>PENDING_CROSS_DEPOSIT_CENSORING/span> span classm>6/span> span classc>// Confirmed, verification in progress. /span>span classn>PENDING_CROSS_DEPOSIT_L2_APPROVING/span> span classm>7/span> span classc>// Pending L2 approval. /span>span classn>CROSS_DEPOSIT_SUCCESS/span> span classm>8/span> span classc>//Deposit successful. /span>span classn>FAILED_CROSS_DEPOSIT_TRANSFER_REJECTED/span> span classm>9/span> span classc>//Transfer rejected. /span>span classn>FAILED_CROSS_DEPOSIT_CENSOR_CHECKING_ACCOUNT_REJECTED/span> span classm>10/span> span classc>//User account error found. /span>span classn>CROSS_DEPOSIT_CENSORING/span> span classm>11/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_CROSS_L2_REJECTED/span> span classm>12/span> span classc>// Transfer has failed. L2 validation rejection, roll back has commenced. /span>span classp>}/span> span classn>Fast/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_FAST_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_FAST_WITHDRAW_CHECKING/span> span classm>1/span> span classc>//Pending checks. /span>span classn>PENDING_FAST_WITHDRAW_SUBMIT/span> span classm>2/span> span classc>//Submitted for checking, creating txid. /span>span classn>PENDING_FAST_WITHDRAW_CHECKING_ACCOUNT/span> span classm>3/span> span classc>// PENDING_FAST_WITHDRAW_CENSORING 4 //Pending data verification. /span>span classn>PENDING_FAST_WITHDRAW_L1_SUBMIT/span> span classm>5/span> span classc>//Confirmed, awaiting send to L1 . /span>span classn>PENDING_FAST_WITHDRAW_L1_CONFIRMING/span> span classm>6/span> span classc>// Confirmed, pending L1 confirmation. /span>span classn>PENDING_FAST_WITHDRAW_CENSORING_CONFIRMING/span> span classm>7/span> span classc>//Pending verification, awaiting confirmation of transfer. /span>span classn>PENDING_FAST_WITHDRAW_L2_APPROVING/span> span classm>8/span> span classc>// Verification successful, pending L2 approval. /span>span classn>FAST_WITHDRAW_SUCCESS/span> span classm>9/span> span classc>// Withdrawal successful, your funds can be found in your wallet. /span>span classn>FAILED_FAST_WITHDRAW_TRANSFER_REJECTED/span> span classm>10/span> span classc>//Transfer rejected. /span>span classn>FAILED_FAST_WITHDRAW_CHECKING_ACCOUNT_REJECTED/span> span classm>11/span> span classc>//User account error found. /span>span classn>FAILED_FAST_WITHDRAW_CENSORING/span> span classm>12/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_FAST_WITHDRAW_L1_SUBMIB_REJECTED/span> span classm>13/span> span classc>// Withdrawal has failed, unsuccessful transfer to L1. /span>span classn>FAILED_FAST_WITHDRAW_L1_REJECTED/span> span classm>14/span> span classc>// Withdrawal unsuccessful, request rejected on L1. /span>span classn>FAILED_FAST_WITHDRAW_L2_REJECTED/span> span classm>15/span> span classc>// L2 validation rejection, roll back has commenced./span>span classn>PENDING_L1_WITHDRAWING/span> span classm>16/span> span classc>// Status: Click for withdrawal smart contract. /span>span classp>}/span> /code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-deposit-data-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameters/th>th>Position/th>th>Type/th>th>Required/th>th>Comments/th>/tr>/thead>tbody>tr>td>limit/td>td>query/td>td>integer/td>td>false/td>td>Page limit default at 100/td>/tr>tr>td>page/td>td>query/td>td>integer/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>currencyId/td>td>query/td>td>string/td>td>true/td>td>Filter to show only currency ID, all will be searched if the field is empty/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>integer/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>chainIds/td>td>query/td>td>string/td>td>false/td>td>Check for multiple chainID records, separated by commas/td>/tr>tr>td>transferType/td>td>query/td>td>string/td>td>false/td>td>Check for multiple transferType records, separated by commas/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>foo/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>DEPOSIT/span>span classp>,/span>span classw> /span>span classnl>currencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classw> /span>span classs2>0x12aaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>confirmedCount/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classnl>requiredCount/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>10.0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>123/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-deposit-data-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-retrieve-user-deposit-data-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» transfers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>DEPOSIT, WITHDRAW or FAST_WITHDRAW/td>/tr>tr>td>»» CurrencyId/td>td>string/td>td>false/td>td>none/td>td>Currency ID/td>/tr>tr>td>»» Amount/td>td>string/td>td>false/td>td>none/td>td>Amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>false/td>td>none/td>td>Transaction hash/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Status/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» confirmedAt/td>td>integer/td>td>false/td>td>none/td>td>Confirmed time (only for withdrawals)/td>/tr>tr>td>»» updatedTime/td>td>string/td>td>true/td>td>none/td>td>Only applicable for deposits/td>/tr>tr>td>»» confirmedCount/td>td>string/td>td>true/td>td>none/td>td>Number of confirmations on L1, only for deposits/td>/tr>tr>td>»» requiredCount/td>td>string/td>td>true/td>td>none/td>td>Number of confirmations required for deposits on L1, only for deposits/td>/tr>tr>td>»» clientId/td>td>string/td>td>false/td>td>none/td>td>Client to create a randomized id (only for withdrawal)/td>/tr>tr>td>»» orderId/td>td>string/td>td>true/td>td>none/td>td>Success Wallet Transaction Id/td>/tr>tr>td>»» chainId/td>td>string/td>td>true/td>td>none/td>td>Supported chainId/td>/tr>tr>td>»» fee/td>td>string/td>td>true/td>td>none/td>td>Fee/td>/tr>tr>td>» totalSize/td>td>string/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-retrieve-user-withdrawal-list-v2>GET Retrieve User Withdrawal List V2/h2>p>code>GET /v2/withdraw-list/code>/p>p>Please note, the token is required to retrieve the user withdrawal list. /p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/withdraw-list?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&beginTimeInclusivespan classo>{/span>beginTimeInclusivespan classo>}/span>&endTimeExclusivespan classo>{/span>endTimeExclusivespan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>withdrawListRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>withdraw_list/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>beginTimeInclusive/span>span classo>/span>span classmi>1651406864000/span>span classp>,/span>span classn>endTimeExclusive/span>span classo>/span>span classmi>1657105971171/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-withdrawal-list-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>limit/td>td>query/td>td>integer/td>td>false/td>td>Page limit default at 100/td>/tr>tr>td>page/td>td>query/td>td>integer/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>integer/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>transferType/td>td>query/td>td>string/td>td>false/td>td>Check for multiple transferType records, separated by commas/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>foo/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classp>,/span>span classw> /span>span classnl>currencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classw> /span>span classs2>0x12aaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING_L2_APPROVING/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>10.0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>123/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-retrieve-user-withdrawal-list-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-retrieve-user-withdrawal-list-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» transfers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>DEPOSIT, WITHDRAW or FAST_WITHDRAW/td>/tr>tr>td>»» CurrencyId/td>td>string/td>td>false/td>td>none/td>td>Currency ID/td>/tr>tr>td>»» Amount/td>td>string/td>td>false/td>td>none/td>td>Amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>false/td>td>none/td>td>Transaction hash/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Status/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» confirmedAt/td>td>integer/td>td>false/td>td>none/td>td>Confirmed time (only for withdrawals)/td>/tr>tr>td>»» updatedTime/td>td>string/td>td>false/td>td>none/td>td>Only applicable for deposits/td>/tr>tr>td>»» confirmedCount/td>td>string/td>td>false/td>td>none/td>td>Number of confirmations on L1, only for deposits/td>/tr>tr>td>»» requiredCount/td>td>string/td>td>false/td>td>none/td>td>Number of confirmations required for deposits on L1, only for deposits/td>/tr>tr>td>»» clientId/td>td>string/td>td>false/td>td>none/td>td>client create the Randomized id (only for withdrawal)/td>/tr>tr>td>»» orderId/td>td>string/td>td>true/td>td>none/td>td>Success Wallet Transaction Id/td>/tr>tr>td>»» chainId/td>td>string/td>td>false/td>td>none/td>td>Supported chainId/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Fee/td>/tr>tr>td>»» withdrawStatus/td>td>string/td>td>false/td>td>none/td>td>PENDING_L2_APPROVING,SUCCESS : Withdrawal status, search for multiple statuses separated by commas/td>/tr>tr>td>» totalSize/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-user-withdrawal-v2>POST User Withdrawal V2/h2>p>code>POST /v2/create-withdrawal/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classp>};/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/create-withdrawal span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal_v2/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1001/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-withdrawal-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset (in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-withdrawal-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-user-withdrawal-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>id/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>type/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-user-withdrawal-to-designated-address-v2>POST User Withdrawal to Designated Address V2/h2>p>code>POST /v2/create-withdrawal-to-address/code>/p>p>Transfer funds from L1 to a designated Ethereum address without the need to register for a corresponding StarkKey associated with the Ethereum address. /p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span>span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span>span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span>span classn>clientId/span>span classp>,/span>span classn>positionId/span>span classp>,/span>span classn>ethAddress/span>span classp>,/span>span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/create-withdrawal span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal_v2/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1001/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classs>0x***/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-withdrawal-to-designated-address-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>Request signature/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Withdraw Amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>false/td>td>Withdraw only to your registered Ethereum address./td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-withdrawal-to-designated-address-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-user-withdrawal-to-designated-address-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>Withdrawal type/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-user-fast-withdrawal-v2>POST User Fast Withdrawal V2/h2>p>code>POST /v2/fast-withdraw/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>fact/span> span classo>/span> span classn>this/span>span classo>./span>span classn>starkLib/span>span classo>./span>span classn>factRegistry/span>span classo>./span>span classn>getTransferErc20Fact/span>span classp>({/span> span classn>recipient/span>span classo>:/span> span classn>toEthAddress/span>span classp>,/span> span classn>tokenAddress/span>span classo>:/span> span classn>usdcAddress/span>span classp>,/span> span classn>tokenDecimals/span>span classo>:/span> span classm>6/span>span classp>,/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>Amount/span>span classp>,/span> span classn>salt/span>span classo>:/span> span classn>nonceFromClientId/span>span classp>(/span>span classn>clientId/span>span classp>),/span> span classp>});/span> span classk>const/span> span classn>transferToSign/span> span classo>/span> span classp>{/span> span classn>senderPositionId/span>span classo>:/span> span classn>accountId/span>span classp>,/span> span classn>receiverPositionId/span>span classo>:/span> span classn>fastWithdrawAccountId/span>span classp>,/span> span classn>receiverPublicKey/span>span classo>:/span> span classn>fastWithdrawL2Key/span>span classp>,/span> span classn>factRegistryAddress/span>span classo>:/span> span classn>fastWithdrawFactRegisterAddress/span>span classp>,/span> span classn>fact/span>span classp>,/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/fast-withdraw span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}&erc20Address{erc20Address}&fee{fee}&lpAccountId{lpAccountId}&chainId{chainId}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee_v2/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1002/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>span classn>fastWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>fast_withdrawal_v2/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1002/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span>span classn>fee/span>span classo>/span>span classn>feeRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>fee/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-fast-withdrawal-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>false/td>td>Withdrawal amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>false/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>false/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>false/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>false/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» erc20Address/td>td>body/td>td>string/td>td>false/td>td>USDC address/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>false/td>td>Fees/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>chainId/td>/tr>tr>td>» lpAccountId/td>td>body/td>td>string/td>td>false/td>td>Attach documents to retrieve fast_withdraw_account_id/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>FAST_WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-user-fast-withdrawal-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-user-fast-withdrawal-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>id/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>type/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-cross-chain-withdrawals-v2>POST Cross-Chain Withdrawals V2/h2>p>code>POST /v2/cross-chain-withdraw/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classn>fee/span>span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/cross-chain-withdraw span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}&erc20Address{erc20Address}&fee{fee}&lpAccountId{lpAccountId}&chainId{chainId}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>span classn>crossWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>cross_chain_withdraw/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span> span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDT/span>span classp>,/span>span classn>fee/span>span classo>/span>span classn>feeRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>fee/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cross-chain-withdrawals-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Withdrawal amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» erc20Address/td>td>body/td>td>string/td>td>true/td>td>USDC address/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>Randomized clientId/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>true/td>td>Fees/td>/tr>tr>td>» lpAccountId/td>td>body/td>td>string/td>td>true/td>td>Attach documents to retrieve fast_withdraw_account_id/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CROSS_WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cross-chain-withdrawals-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-cross-chain-withdrawals-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>Withdrawal type/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-fast-amp-cross-chain-withdrawal-fees-v2>GET Fast & Cross-Chain Withdrawal Fees V2/h2>p>code>GET /v2/uncommon-withdraw-fee/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/uncommon-withdraw-fee?amountspan classo>{/span>amountspan classo>}/span>&chainIdspan classo>{/span>chainIdspan classo>}/span>&tokenspan classo>/span>USDC span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-fast-amp-cross-chain-withdrawal-fees-v2-request-parameters>Request Parameters/h3>p>Please note, the token is required to request parameters. /p>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>amount/td>td>query/td>td>string/td>td>false/td>td>USDC/td>/tr>tr>td>chainId/td>td>query/td>td>string/td>td>false/td>td>chainId/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDC USDT/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>1.1/span>span classp>,/span>span classw> /span>span classnl>poolAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>10/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-fast-amp-cross-chain-withdrawal-fees-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-fast-amp-cross-chain-withdrawal-fees-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» fee/td>td>string/td>td>true/td>td>none/td>td>Fees calculated/td>/tr>tr>td>» poolAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Available balance in pool/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-withdrawal-amp-transfer-limits-v2>GET Withdrawal & Transfer Limits V2/h2>p>code>GET /v2/transfer-limit/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/transfer-limit?currencyIdspan classo>/span>USDC span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>transfer_limitRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>transfer_limit/span>span classp>(/span>span classn>currencyId/span>span classo>/span>span classs>USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-withdrawal-amp-transfer-limits-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>currencyId/td>td>query/td>td>string/td>td>true/td>td>USDC/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>withdrawAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>transferAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-withdrawal-amp-transfer-limits-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-withdrawal-amp-transfer-limits-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» withdrawAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Withdraw available amount/td>/tr>tr>td>» transferAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Transfer available amount/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-trade-history>GET Trade History/h2>p>code>GET /v2/fills/code>/p>p>Please note, the token is required to retrieve a trade history. /p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/fills?limitspan classo>/span>100&pagespan classo>/span>0&symbolspan classo>/span>BTC-USDC&sidespan classo>/span>BUY&tokenspan classo>/span>USDC span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>fillsRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>fills_v2/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classn>Type/span> span classs>UNKNOWN_ORDER_TYPE/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-trade-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDC USDT/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>orderType/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-trade-history-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-trade-history-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total order size/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-worst-price-v2>GET Worst Price V2/h2>p>code>GET /v2/get-worst-price/code>/p>p>Obtain the market price from the order book. /p>h3 idprivateapi-v2-for-pro-get-worst-price-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>size/td>td>query/td>td>string/td>td>true/td>td>Order open size/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>true/td>td>BUY or SELL order/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>worstPrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>bidOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>askOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-worst-price-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-worst-price-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» worstPrice/td>td>string/td>td>true/td>td>none/td>td>Lowest price/td>/tr>tr>td>» bidOnePrice/td>td>string/td>td>true/td>td>none/td>td>Bid price/td>/tr>tr>td>» askOnePrice/td>td>string/td>td>true/td>td>none/td>td>Ask price/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-creating-orders-v2>POST Creating Orders V2/h2>p>code>POST /v2/create-order/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Signature/span> span classn>content/span>span classo>:/span> span classn>orderToSign/span>span classo>:/span> span classn>OrderWithClientId/span> span classo>/span> span classp>{/span> span classn>humanSize/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>size/span>span classp>,/span> span classn>humanPrice/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>price/span>span classp>,/span> span classn>limitFee/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>limitFee/span>span classp>,/span> span classn>symbol/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>symbol/span>span classp>,/span> span classn>side/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>side/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span>span classn>clientOrderId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classp>};/span> span classn>TimeInForce/span> span classp>(/span> span classn>GOOD_TIL_CANCEL/span> span classc>// Effective until canceled, default. /span>span classn>FILL_OR_KILL/span> span classc>// Immediately and completely filled or canceled. /span>span classn>IMMEDIATE_OR_CANCEL/span> span classc>// Immediately executed or canceled. /span>span classp>)/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/create-order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{symbol}&side{side}&type{type}&size{size}&price{price}&limitFee{limitFee}&expiration{expiration}&timeInForce{timeInForce}&triggerPrice{triggerPrice}&trailingPercent{trailingPercent}&clientOrderId{clientOrderId}&signature{signature}&reduceOnlyfalse/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_order_v2/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span> span classn>side/span>span classo>/span>span classs>BUY/span>span classp>,/span> span classnb>type/span>span classo>/span>span classs>LIMIT/span>span classp>,/span> span classn>size/span>span classo>/span>span classs>0.01/span>span classp>,/span> span classn>price/span>span classo>/span>span classs>20001/span>span classp>,/span> span classn>limitFee/span>span classo>/span>span classs>0.001/span>span classp>,/span> span classn>accountId/span>span classo>/span>span classs>330547708362228116/span>span classp>,/span>span classn>reduceOnly/span>span classo>/span>span classbp>False/span>span classp>,/span> span classn>expirationEpochSeconds/span>span classo>/span> span classn>currentTime/span>span classp>,/span> span classn>timeInForce/span>span classo>/span>span classs>GOOD_TIL_CANCEL/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-creating-orders-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>» side/td>td>body/td>td>string/td>td>true/td>td>BUY or SELL/td>/tr>tr>td>» type/td>td>body/td>td>string/td>td>true/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT", "TAKE_PROFIT_MARKET"/td>/tr>tr>td>» size/td>td>body/td>td>string/td>td>true/td>td>Size/td>/tr>tr>td>» price/td>td>body/td>td>string/td>td>true/td>td>Price/td>/tr>tr>td>» limitFee/td>td>body/td>td>string/td>td>true/td>td>limitFee price * size * takerFeeRate( from GET /v1/account)/td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Order expiry time/td>/tr>tr>td>» timeInForce/td>td>body/td>td>string/td>td>false/td>td>"GOOD_TIL_CANCEL", "FILL_OR_KILL", "IMMEDIATE_OR_CANCEL", "POST_ONLY"/td>/tr>tr>td>» triggerPrice/td>td>body/td>td>string/td>td>false/td>td>Trigger price/td>/tr>tr>td>» trailingPercent/td>td>body/td>td>string/td>td>false/td>td>Conditional order trailing-stop/td>/tr>tr>td>» clientOrderId/td>td>body/td>td>string/td>td>true/td>td>Randomized client id/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>starkKey signature/td>/tr>tr>td>» reduceOnly/td>td>body/td>td>string/td>td>false/td>td>Reduce-only/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-creating-orders-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-creating-orders-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-cancel-order-v2>POST Cancel Order V2/h2>p>code>POST /v2/delete-order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/delete-order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}&token{USDC}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>,/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-order-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>» token/td>td>body/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-order-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-cancel-order-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-cancel-order-by-clientorderid>POST Cancel Order By ClientOrderId/h2>p>code>POST /v2/delete-client-order-id/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/delete-client-order-idspan classsb>`/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order_by_client_order_id_v2/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>,/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-order-by-clientorderid-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>» token/td>td>body/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-order-by-clientorderid-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-cancel-order-by-clientorderid-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-open-orders-v2>GET Open Orders V2/h2>p>code>GET /v2/open-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>openOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>open_orders_v2/span>span classp>(/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-open-orders-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-open-orders-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-open-orders-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-cancel-all-open-orders-v2>POST Cancel all Open Orders V2/h2>p>code>POST /v2/delete-open-orders/code>/p>blockquote>p>Body Request Parameters/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>BTC-USDC,ETH-USDC/span>span classna>token/span>span classpi>:/span> span classs>USDC/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/delete-open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{BTC-USDC,ETH-USDC}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_open_orders_v2/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC,ETH-USDC/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-all-open-orders-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>false/td>td>"BTC-USDC,ETH-USDC", Cancel all orders if none/td>/tr>tr>td>» token/td>td>body/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-cancel-all-open-orders-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-cancel-all-open-orders-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>h2 idprivateapi-v2-for-pro-get-all-order-history-v2>GET All Order History V2/h2>p>code>GET /v2/history-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/history-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historyOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_orders_v2/span>span classp>(/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-all-order-history-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT","TAKE_PROFIT_MARKET"/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>"ACTIVE","CONDITION","HISTORY"/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-all-order-history-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-all-order-history-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>total order size/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-order-id-v2>GET Order ID V2/h2>p>code>GET /v2/get-order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/get-order?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order_v2/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>,/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-order-id-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-order-id-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-order-id-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-order-by-clientorderid-v2>GET Order by clientOrderId V2/h2>p>code>GET /v2/order-by-client-order-id"/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/order-by-client-order-id?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order_by_client_order_id_v2/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>,/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-order-by-clientorderid-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDC or USDT/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-order-by-clientorderid-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-order-by-clientorderid-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-funding-rate-v2>GET Funding Rate V2/h2>p>code>GET /v2/funding/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/funding?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span>&sidespan classo>{/span>sidespan classo>}/span>&tokenspan classo>{/span>tokenspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>fundingRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>funding_v2/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-funding-rate-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>Side/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>Order status/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fundingValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>fundingValue/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>positionSize/span>span classp>:/span>span classw> /span>span classs2>500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>90/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>transactionId/span>span classp>:/span>span classw> /span>span classs2>1234556/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-funding-rate-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-funding-rate-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» fundingValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>id/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» fundingValue/td>td>string/td>td>false/td>td>none/td>td>Funding fee value/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» positionSize/td>td>string/td>td>false/td>td>none/td>td>Open position size/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Symbol price/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Position side/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Position funding status/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Funding fee time/td>/tr>tr>td>»» transactionId/td>td>string/td>td>false/td>td>none/td>td>Successful wallet transaction ID/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-user-historial-profit-and-loss-v2>GET User Historial Profit and Loss V2/h2>p>code>GET /v2/historical-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/historical-pnl?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&beginTimeInclusivespan classo>{/span>beginTimeInclusivespan classo>}/span>&endTimeExclusivespan classo>{/span>endTimeExclusivespan classo>}/span>&typespan classo>{/span>span classnb>type/span>span classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span>&tokenspan classo>{/span>tokenspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historicalPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>historical_pnl_v2/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>beginTimeInclusive/span>span classo>/span>span classmi>1651406864000/span>span classp>,/span>span classn>endTimeExclusive/span>span classo>/span>span classmi>1657105971171/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span> span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-user-historial-profit-and-loss-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>StartTime/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>EndTime/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>Position type/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historicalPnl/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>totalPnl/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CLOSE_POSITION/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-user-historial-profit-and-loss-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-user-historial-profit-and-loss-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historicalPnl/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» totalPnl/td>td>string/td>td>false/td>td>none/td>td>Closing profit and loss/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» exitPrice/td>td>string/td>td>false/td>td>none/td>td>Closing price/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>postion type/td>/tr>tr>td>»» isLiquidate/td>td>boolean/td>td>false/td>td>none/td>td>Liquidate/td>/tr>tr>td>»» isDeleverage/td>td>boolean/td>td>false/td>td>none/td>td>ADL/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-yesterday-39-s-profit-amp-loss-v2>GET Yesterday's Profit & Loss V2/h2>p>code>GET /v2/yesterday-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/yesterday-pnl?tokenspan classo>{/span>tokenspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>yesterdayPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>yesterday_pnl_v2/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-yesterday-39-s-profit-amp-loss-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>11.11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-yesterday-39-s-profit-amp-loss-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-yesterday-39-s-profit-amp-loss-v2-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Profit and loss value/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-get-historical-asset-value>GET Historical Asset Value/h2>p>code>GET /v2/history-value/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/history-value?tokenspan classo>{/span>tokenspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historyValueRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_value_v2/span>span classp>(/span>span classn>token/span>span classo>/span>span classs>USDT/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-historical-asset-value-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>token/td>td>query/td>td>string/td>td>true/td>td>USDT or USDC/td>/tr>tr>td>endTime/td>td>query/td>td>int64/td>td>false/td>td>Start time/td>/tr>tr>td>startTime/td>td>query/td>td>int64/td>td>false/td>td>End time/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>accountTotalValue/span>span classp>:/span>span classw> /span>span classs2>123.11/span>span classp>,/span>span classw> /span>span classnl>dateTime/span>span classp>:/span>span classw> /span>span classmi>1651406864000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-get-historical-asset-value-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-get-historical-asset-value-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historyValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» accountTotalValue/td>td>string/td>td>false/td>td>none/td>td>Assets/td>/tr>tr>td>»» dateTime/td>td>integer/td>td>false/td>td>none/td>td>Assets date and time snapshot/td>/tr>/tbody>/table>h2 idprivateapi-v2-for-pro-post-sets-the-initial-margin-rate-of-a-contract-v2>POST Sets the initial margin rate of a contract V2/h2>p>POST /v2/set-initial-margin-rate/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v2/set-initial-margin-rate?symbolspan classo>{/span>symbolspan classo>}/span>&initialMarginRatespan classo>{/span>initialMarginRatespan classo>}/span> span classnt>-H/span> span classs2>Content-Type: application/x-www-form-urlencoded/span> span classnt>-H/span> span classs2>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs2>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs2>APEX-API-KEY: ***/span> span classnt>-H/span> span classs2>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs2>symbolBTC-USDC&initialMarginRate0.02/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>setInitialMarginRateRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>set_initial_margin_rate_v2/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDT/span>span classp>,/span>span classn>initialMarginRate/span>span classo>/span>span classs>0.1/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>setInitialMarginRateRes/span>span classp>)/span>/code>/pre>/div>blockquote>p>Body /p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>string/span>span classna>initialMarginRate/span>span classpi>:/span> span classs>string/span>span classna>token/span>span classpi>:/span> span classs>string/span>/code>/pre>/div>h3 idprivateapi-v2-for-pro-post-sets-the-initial-margin-rate-of-a-contract-v2-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>symbol/td>/tr>tr>td>» initialMarginRate/td>td>body/td>td>string/td>td>true/td>td>initialMarginRate(the reciprocal of the opening leverage)/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>h3 idprivateapi-v2-for-pro-post-sets-the-initial-margin-rate-of-a-contract-v2-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-v2-for-pro-post-sets-the-initial-margin-rate-of-a-contract-v2-response-parameters>Response Parameters/h3>h1 idprivateapi>PrivateApi/h1>p>v1.0.0 /p>h2 idprivateapi-post-generate-nonce>POST Generate nonce/h2>p>code>POST /v1/generate-nonce/code>/p>p>Generate and obtain nonce before registration. The nonce is used to assemble the signature field upon registration./p>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classs>0x*****/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs/span>span classp>()/span>span classn>stark_key_pair_with_y_coordinate/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_stark_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce/span>span classp>(/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>5/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/generate-nonce span classnt>-X/span> POST span classnt>-d/span> span classs1>starkKey{starkKey}&ethAddress{ethAddress}&chainId{chainId}/span>/code>/pre>/div>h3 idprivateapi-post-generate-nonce-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» starkKey/td>td>body/td>td>string/td>td>true/td>td>User's starkKey/td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>true/td>td>User's Ethereum address/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>API trading users to enter "1" on mainnet/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1123940951220551680/span>span classp>,/span>span classw> /span>span classnl>nonceExpired/span>span classp>:/span>span classw> /span>span classmi>1648727402292/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-generate-nonce-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-generate-nonce-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» nonce/td>td>string/td>td>true/td>td>none/td>td>nonce/td>/tr>tr>td>» nonceExpired/td>td>integer/td>td>true/td>td>none/td>td>The time at which nonce expires, please complete registration before this time/td>/tr>/tbody>/table>h2 idprivateapi-post-registration-amp-onboarding>POST Registration & Onboarding/h2>p>code>POST /v1/onboarding/code> /p>ol>li>Consolidate onboarding data and generate digital signature via your wallet. You can refer to python sdk, derive_stark_key for more information/li>li>Create your Stark Key pair with your signature, including (publicKey, publicKeyYCoordinate, privateKey）/li>li>Send consolidated onboarding data request to the server for response to user registration data, including API keys/li>/ol>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/onboarding span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-ETHEREUM-ADDRESS: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>starkKey{starkKey}&starkKeyYCoordinate{starkKeyYCoordinate}&ethereumAddress{ethereumAddress}&referredByAffiliateLink{referredByAffiliateLink}&country{country}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>eth_private_key/span>span classo>/span>span classs>0xb7daaaaaaaaaaaaaaaa/span>span classp>)/span>span classn>configs/span> span classo>/span> span classn>client/span>span classp>./span>span classn>configs/span>span classp>()/span>span classn>stark_key_pair_with_y_coordinate/span> span classo>/span> span classn>client/span>span classp>./span>span classn>derive_stark_key/span>span classp>(/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>span classn>nonceRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>generate_nonce/span>span classp>(/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>5/span>span classp>)/span>span classn>regRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>register_user/span>span classp>(/span>span classn>nonce/span>span classo>/span>span classn>nonceRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>nonce/span>span classp>,/span>span classn>starkKey/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key/span>span classp>,/span>span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>stark_key_pair_with_y_coordinate/span>span classp>/span>span classs>public_key_y_coordinate/span>span classp>,/span>span classn>ethereum_address/span>span classo>/span>span classn>client/span>span classp>./span>span classn>default_address/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-registration-amp-onboarding-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Onboarding signature/td>/tr>tr>td>APEX-ETHEREUM-ADDRESS/td>td>header/td>td>string/td>td>true/td>td>Ethereum address/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» starkKey/td>td>body/td>td>string/td>td>true/td>td>Public starkKey associated with the key-pair you created./td>/tr>tr>td>» starkKeyYCoordinate/td>td>body/td>td>string/td>td>true/td>td>Public starkKey Y-Coordinate associated with the key-pair you created./td>/tr>tr>td>» ethereumAddress/td>td>body/td>td>string/td>td>true/td>td>Ethereum address associated with the user being created./td>/tr>tr>td>» referredByAffiliateLink/td>td>body/td>td>string/td>td>false/td>td>Referred affiliate link/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>Country code: Must be ISO 3166-1 Alpha-2 compliant/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>apiKey/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classs2>290xxxxxx/span>span classp>,/span>span classw> /span>span classnl>passphrase/span>span classp>:/span>span classw> /span>span classs2>S6xxxxx/span>span classp>,/span>span classw> /span>span classnl>secret/span>span classp>:/span>span classw> /span>span classs2>KQ3xxxx/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x09xxxxxx/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>man/span>span classp>,/span>span classw> /span>span classnl>referredByAffiliateLink/span>span classp>:/span>span classw> /span>span classs2>url/span>span classp>,/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>account/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>starkKey/span>span classp>:/span>span classw> /span>span classs2>180913017c740260fea4b2c62828a4008ca8b0d6e4/span>span classp>,/span>span classw> /span>span classnl>positionId/span>span classp>:/span>span classw> /span>span classs2>1812/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1812/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>123455667/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>openPositions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>id/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-registration-amp-onboarding-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-registration-amp-onboarding-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» apiKey/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» key/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» passphrase/td>td>string/td>td>true/td>td>none/td>td>Placed in request header for sending to server/td>/tr>tr>td>»» secret/td>td>string/td>td>true/td>td>none/td>td>Used to generate signature/td>/tr>tr>td>» user/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>»» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration confirmation/td>/tr>tr>td>»» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>»» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>»» referredByAffiliateLink/td>td>string/td>td>true/td>td>none/td>td>referred Affiliate Link/td>/tr>tr>td>»» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>Email binding confirmation/td>/tr>tr>td>»» emailNotifyGeneralEnable/td>td>boolean/td>td>true/td>td>none/td>td>Newsletter, Market Updates, Product notify/td>/tr>tr>td>»» emailNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Deposits、Withdrawals, Account notify/td>/tr>tr>td>»» emailNotifyAccountEnable/td>td>boolean/td>td>true/td>td>none/td>td>Order and Liquidation notify/td>/tr>tr>td>»» popupNotifyTradingEnable/td>td>boolean/td>td>true/td>td>none/td>td>Trading pop-up notify/td>/tr>tr>td>» account/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» starkKey/td>td>string/td>td>true/td>td>none/td>td>User's starkKey/td>/tr>tr>td>»» positionId/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»» wallets/td>td>object/td>td>true/td>td>none/td>td>User wallet/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User ID/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»»» asset/td>td>string/td>td>false/td>td>none/td>td>Asset/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-get-retrieve-user-data>GET Retrieve User Data/h2>p>code>GET /v1/user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_user/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-retrieve-user-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-post-edit-user-data>POST Edit User Data/h2>p>code>POST /v1/modify-user/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/modify-user span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>userData{userData}&email{email}&username{username}&isSharingUsername{isSharingUsername}&isSharingAddress{isSharingAddress}&country{country}&emailNotifyGeneralEnable{emailNotifyGeneralEnable}&emailNotifyTradingEnable{emailNotifyTradingEnable}&emailNotifyAccountEnable{emailNotifyAccountEnable}&popupNotifyTradingEnable{popupNotifyTradingEnable}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>userRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>modify_user/span>span classp>(/span>span classn>username/span>span classo>/span>span classs>pythonTest/span>span classp>,/span>span classn>email/span>span classo>/span>span classs>11@aa.com/span>span classp>,/span>span classn>emailNotifyGeneralEnable/span>span classo>/span>span classs>true/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-edit-user-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» userData/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» email/td>td>body/td>td>string/td>td>false/td>td>Email/td>/tr>tr>td>» username/td>td>body/td>td>string/td>td>false/td>td>Username/td>/tr>tr>td>» isSharingUsername/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» isSharingAddress/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>» country/td>td>body/td>td>string/td>td>false/td>td>country/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>body/td>td>string/td>td>false/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>body/td>td>string/td>td>false/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>body/td>td>string/td>td>false/td>td>Enable trading notifications/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ethereumAddress/span>span classp>:/span>span classw> /span>span classs2>0x091aaaaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>isRegistered/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>email@apex.exchange/span>span classp>,/span>span classw> /span>span classnl>username/span>span classp>:/span>span classw> /span>span classs2>supersam15o/span>span classp>,/span>span classw> /span>span classnl>userData/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>isEmailVerified/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyGeneralEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>emailNotifyAccountEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>popupNotifyTradingEnable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-edit-user-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-edit-user-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» ethereumAddress/td>td>string/td>td>true/td>td>none/td>td>Ethereum address/td>/tr>tr>td>» isRegistered/td>td>boolean/td>td>true/td>td>none/td>td>Registration completed/td>/tr>tr>td>» email/td>td>string/td>td>true/td>td>none/td>td>Email/td>/tr>tr>td>» username/td>td>string/td>td>true/td>td>none/td>td>Username/td>/tr>tr>td>» userData/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» isEmailVerified/td>td>boolean/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» emailNotifyGeneralEnable/td>td>string/td>td>true/td>td>none/td>td>Newsletter, market and product updates/td>/tr>tr>td>» emailNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Order and liquidation updates/td>/tr>tr>td>» emailNotifyAccountEnable/td>td>string/td>td>true/td>td>none/td>td>Deposit, withdrawal and account updates/td>/tr>tr>td>» popupNotifyTradingEnable/td>td>string/td>td>true/td>td>none/td>td>Enable trading notifications/td>/tr>/tbody>/table>h2 idprivateapi-get-retrieve-user-account-data>GET Retrieve User Account Data/h2>p>code>GET /v1/account/code>/p>p>Get an account for a user by id. Using the client, the id will be generated with client information and an Ethereum address./p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/account span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-account-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>starkKey/span>span classp>:/span>span classw> /span>span classs2>180913017c740260fea4b2c62828a4008ca8b0d6e4/span>span classp>,/span>span classw> /span>span classnl>positionId/span>span classp>:/span>span classw> /span>span classs2>1812/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.0005/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>123455667/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>openPositions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>50/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>lightNumbers/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>id/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-account-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-retrieve-user-account-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>»» starkKey/td>td>string/td>td>true/td>td>none/td>td>User's starkKey/td>/tr>tr>td>»» positionId/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» id/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»» makerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»» takerFeeRate/td>td>string/td>td>true/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>Created time/td>/tr>tr>td>»» wallets/td>td>object/td>td>true/td>td>none/td>td>User wallet/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User ID/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»»» asset/td>td>string/td>td>false/td>td>none/td>td>Asset/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>true/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>true/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>true/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>true/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»» openPositions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Side/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» entryPrice/td>td>string/td>td>false/td>td>none/td>td>Entry price/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Updated time/td>/tr>tr>td>»» fundingFee/td>td>string/td>td>false/td>td>none/td>td>Funding fee/td>/tr>tr>td>»» lightNumbers/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>/tbody>/table>h2 idprivateapi-get-retrieve-user-account-balance>GET Retrieve User Account balance/h2>p>code>GET /v1/account-balance/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/account-balance span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>accountRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_account_balance/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-account-balance-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>totalEquityValue/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>availableBalance/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>initialMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>maintenanceMargin/span>span classp>:/span>span classw> /span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>symbolToOraclePrice/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>BTC-USDC/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>oraclePrice/span>span classp>:/span>span classw> /span>span classs2>20000/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>124566/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-account-balance-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-retrieve-user-account-balance-response-parameters>Response Parameters/h3>p>Status code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» totalEquityValue/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» availableBalance/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» initialMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» maintenanceMargin/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» symbolToOraclePrice/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» BTC-USDC/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» oraclePrice/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» createdTime/td>td>integer/td>td>true/td>td>none/td>td>/td>/tr>/tbody>/table>h2 idprivateapi-get-retrieve-user-deposit-data>GET Retrieve User Deposit Data/h2>p>code>GET /v1/transfers/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/transfers?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&currencyIdspan classo>{/span>currencyIdspan classo>}/span>&chainIdsspan classo>{/span>chainIdsspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>transfersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>transfers/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>currencyId/span>span classo>/span>span classs>USDC/span>span classp>,/span>span classn>chainIds/span>span classo>/span>span classs>1,5,13/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>Deposit/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_DEPOSIT_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_L1_CREATING/span> span classm>1/span> span classc>// Deposit pending on L1, awaiting confirmation. /span>span classn>PENDING_RISK_CHECKING/span> span classm>2/span> span classc>// Confirmed, risk check in progress. /span>span classn>PENDING_CENSORING/span> span classm>3/span> span classc>// Risk check complete, awaiting verification. /span>span classn>SUCCESS/span> span classm>4/span> span classc>// Deposit success, your funds have been sent to your wallet. Awaiting L2 validation. /span>span classn>SUCCESS_L2_APPROVED/span> span classm>5/span> span classc>// L2 approved. /span>span classn>CANCELED/span> span classm>6/span> span classc>// L1 confirmation failure, deposit has been canceled. /span>span classn>FAILED_RISK_CHECK_FAILURE/span> span classm>7/span> span classc>// Deposit has failed due to failed risk check. /span>span classn>FAILED_CENSOR_FAILURE/span> span classm>8/span> span classc>// Deposit has failed due to inaccurate data, data entries have been rolled back. /span>span classn>FAILED_L2_REJECTED/span> span classm>9/span> span classc>// Deposit has failed due to failed L2 approval. Deposited funds have been removed from your account. /span>span classp>}/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_RISK_CHECKING/span> span classm>1/span> span classc>// Risk check in progress. /span>span classn>PENDING_CENSORING/span> span classm>2/span> span classc>// Pending verification. /span>span classn>PENDING_L2_APPROVING/span> span classm>3/span> span classc>// Approved, awaiting L2 validation. /span>span classn>PENDING_L1_CONFIRMING/span> span classm>4/span> span classc>// L2 validation complete, pending L1 confirmation. /span>span classn>PENDING_L1_WITHDRAWING/span> span classm>5/span> span classc>// Withdrawal request on L1 complete, awaiting user withdrawal. /span>span classn>SUCCESS/span> span classm>6/span> span classc>// Withdrawal success, your withdrawn funds can now be found in your wallet. /span>span classn>FAILED_RISK_CHECK_FAILURE/span> span classm>7/span> span classc>// Withdrawal unsuccessful due to failed risk check. /span>span classn>FAILED_CENSOR_FAILURE/span> span classm>8/span> span classc>// Withdrawal unsuccessful due to inaccurate data, data entries have been rolled back. /span>span classn>FAILED_L2_REJECTED/span> span classm>9/span> span classc>// Withdrawal unsuccessful due to failed L2 approval and roll back has commenced. /span>span classp>}/span> span classn>Cross/span>span classo>-/span>span classn>Chain/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_CROSS_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_CROSS_WITHDRAW_CHECKING/span> span classm>1/span> span classc>// Pending chain verification. /span>span classn>SUCCESS_CROSS_WITHDRAW_SUBMIT_CENSOR/span> span classm>2/span> span classn>PENDING_CROSS_WITHDRAW__CENSOR_CHECKING_ACCOUNT/span> span classm>3/span> span classc>// /span>span classn>PENDING_CROSS_WITHDRAW_CENSORING/span> span classm>4/span> span classc>// Pending data verification. /span>span classn>PENDING_CROSS_WITHDRAW_L2_APPROVING/span> span classm>5/span> span classc>// Verification successful, awaiting L2 approval. /span>span classn>PENDING_CROSS_WITHDRAW_L1_SUBMIT/span> span classm>6/span> span classc>//Approved, submitting to L1. /span>span classn>PENDING_CROSS_WITHDRAW_L1_CONFIRMING/span> span classm>7/span> span classc>// L1 submission successful, pending L1 validation. /span>span classn>CROSS_WITHDRAW_SUCCESS/span> span classm>8/span> span classc>// Withdrawal successful. /span>span classn>FAILED_CROSS_WITHDRAW_TRANSFER_REJECTED/span> span classm>9/span> span classo>//span>span classn>Transfer/span> span classn>rejected/span>span classo>./span> span classn>FAILED_CROSS_WITHDRAW__CENSOR_CHECKING_ACCOUNT_REJECTED/span> span classm>10/span> span classc>//Account verification rejected. /span>span classn>FAILED_CROSS_WITHDRAW_CENSORING/span> span classm>11/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_CROSS_L2_REJECTED/span> span classm>12/span> span classc>// Transfer has failed. L2 validation rejection, roll back has commenced. /span>span classn>FAILED_CROSS_WITHDRAW_L1_SUBMIT_REJECTED/span> span classm>13/span> span classn>FAILED_CROSS_WITHDRAW_L1_REJECTED/span> span classm>14/span>span classc>// Withdrawal request failed, L1 transfer unsuccessful. /span>span classp>}/span> span classn>Cross/span>span classo>-/span>span classn>Chain/span> span classn>Deposit/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_CROSS_DEPOSIT_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_CROSS_DEPOSIT_L1_CREATING/span> span classm>1/span> span classc>// Deposit confirmed on L1, creating transaction. /span>span classn>PENDING_CROSS_DEPOSIT_L2_TRIGGER/span> span classm>2/span> span classc>// Awaiting trigger for transfer to L2. /span>span classn>PENDING_CROSS_DEPOSIT_CENSOR_CHECKING/span> span classm>3/span> span classc>// L1 deposit successful, awaiting transfer to L2. /span>span classn>SUCCESS_CROSS_DEPOSIT_SUBMIT_CENSOR/span> span classm>4/span> span classn>PENDING_CROSS_DEPOSIT_CENSOR_CHECKING_ACCOUNT/span> span classm>5/span> span classc>// /span>span classn>PENDING_CROSS_DEPOSIT_CENSORING/span> span classm>6/span> span classc>// Confirmed, verification in progress. /span>span classn>PENDING_CROSS_DEPOSIT_L2_APPROVING/span> span classm>7/span> span classc>// Pending L2 approval. /span>span classn>CROSS_DEPOSIT_SUCCESS/span> span classm>8/span> span classc>//Deposit successful. /span>span classn>FAILED_CROSS_DEPOSIT_TRANSFER_REJECTED/span> span classm>9/span> span classc>//Transfer rejected. /span>span classn>FAILED_CROSS_DEPOSIT_CENSOR_CHECKING_ACCOUNT_REJECTED/span> span classm>10/span> span classc>//User account error found. /span>span classn>CROSS_DEPOSIT_CENSORING/span> span classm>11/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_CROSS_L2_REJECTED/span> span classm>12/span> span classc>// Transfer has failed. L2 validation rejection, roll back has commenced. /span>span classp>}/span> span classn>Fast/span> span classn>Withdrawal/span> span classn>Status/span>span classp>{/span> span classn>UNKNOWN_FAST_WITHDRAW_STATUS/span> span classm>0/span> span classc>// Unknown. /span>span classn>PENDING_FAST_WITHDRAW_CHECKING/span> span classm>1/span> span classc>//Pending checks. /span>span classn>PENDING_FAST_WITHDRAW_SUBMIT/span> span classm>2/span> span classc>//Submitted for checking, creating txid. /span>span classn>PENDING_FAST_WITHDRAW_CHECKING_ACCOUNT/span> span classm>3/span> span classc>// PENDING_FAST_WITHDRAW_CENSORING 4 //Pending data verification. /span>span classn>PENDING_FAST_WITHDRAW_L1_SUBMIT/span> span classm>5/span> span classc>//Confirmed, awaiting send to L1 . /span>span classn>PENDING_FAST_WITHDRAW_L1_CONFIRMING/span> span classm>6/span> span classc>// Confirmed, pending L1 confirmation. /span>span classn>PENDING_FAST_WITHDRAW_CENSORING_CONFIRMING/span> span classm>7/span> span classc>//Pending verification, awaiting confirmation of transfer. /span>span classn>PENDING_FAST_WITHDRAW_L2_APPROVING/span> span classm>8/span> span classc>// Verification successful, pending L2 approval. /span>span classn>FAST_WITHDRAW_SUCCESS/span> span classm>9/span> span classc>// Withdrawal successful, your funds can be found in your wallet. /span>span classn>FAILED_FAST_WITHDRAW_TRANSFER_REJECTED/span> span classm>10/span> span classc>//Transfer rejected. /span>span classn>FAILED_FAST_WITHDRAW_CHECKING_ACCOUNT_REJECTED/span> span classm>11/span> span classc>//User account error found. /span>span classn>FAILED_FAST_WITHDRAW_CENSORING/span> span classm>12/span> span classc>//Inaccurate validation data. /span>span classn>FAILED_FAST_WITHDRAW_L1_SUBMIB_REJECTED/span> span classm>13/span> span classc>// Withdrawal has failed, unsuccessful transfer to L1. /span>span classn>FAILED_FAST_WITHDRAW_L1_REJECTED/span> span classm>14/span> span classc>// Withdrawal unsuccessful, request rejected on L1. /span>span classn>FAILED_FAST_WITHDRAW_L2_REJECTED/span> span classm>15/span> span classc>// L2 validation rejection, roll back has commenced./span>span classn>PENDING_L1_WITHDRAWING/span> span classm>16/span> span classc>// Status: Click for withdrawal smart contract. /span>span classp>}/span> /code>/pre>/div>h3 idprivateapi-get-retrieve-user-deposit-data-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameters/th>th>Position/th>th>Type/th>th>Required/th>th>Comments/th>/tr>/thead>tbody>tr>td>limit/td>td>query/td>td>integer/td>td>false/td>td>Page limit default at 100/td>/tr>tr>td>page/td>td>query/td>td>integer/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>currencyId/td>td>query/td>td>string/td>td>false/td>td>Filter to show only currency ID, all will be searched if the field is empty/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>integer/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>chainIds/td>td>query/td>td>string/td>td>false/td>td>Check for multiple chainID records, separated by commas/td>/tr>tr>td>transferType/td>td>query/td>td>string/td>td>false/td>td>Check for multiple transferType records, separated by commas/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>foo/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>DEPOSIT/span>span classp>,/span>span classw> /span>span classnl>currencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classw> /span>span classs2>0x12aaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>confirmedCount/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classnl>requiredCount/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>10.0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>123/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-deposit-data-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-retrieve-user-deposit-data-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» transfers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>DEPOSIT, WITHDRAW or FAST_WITHDRAW/td>/tr>tr>td>»» CurrencyId/td>td>string/td>td>false/td>td>none/td>td>Currency ID/td>/tr>tr>td>»» Amount/td>td>string/td>td>false/td>td>none/td>td>Amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>false/td>td>none/td>td>Transaction hash/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Status/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» confirmedAt/td>td>integer/td>td>false/td>td>none/td>td>Confirmed time (only for withdrawals)/td>/tr>tr>td>»» updatedTime/td>td>string/td>td>true/td>td>none/td>td>Only applicable for deposits/td>/tr>tr>td>»» confirmedCount/td>td>string/td>td>true/td>td>none/td>td>Number of confirmations on L1, only for deposits/td>/tr>tr>td>»» requiredCount/td>td>string/td>td>true/td>td>none/td>td>Number of confirmations required for deposits on L1, only for deposits/td>/tr>tr>td>»» clientId/td>td>string/td>td>false/td>td>none/td>td>Client to create a randomized id (only for withdrawal)/td>/tr>tr>td>»» orderId/td>td>string/td>td>true/td>td>none/td>td>Success Wallet Transaction Id/td>/tr>tr>td>»» chainId/td>td>string/td>td>true/td>td>none/td>td>Supported chainId/td>/tr>tr>td>»» fee/td>td>string/td>td>true/td>td>none/td>td>Fee/td>/tr>tr>td>» totalSize/td>td>string/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-get-retrieve-user-withdrawal-list>GET Retrieve User Withdrawal List/h2>p>code>GET /v1/withdraw-list/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/withdraw-list?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&beginTimeInclusivespan classo>{/span>beginTimeInclusivespan classo>}/span>&endTimeExclusivespan classo>{/span>endTimeExclusivespan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>withdrawListRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>withdraw_list/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>beginTimeInclusive/span>span classo>/span>span classmi>1651406864000/span>span classp>,/span>span classn>endTimeExclusive/span>span classo>/span>span classmi>1657105971171/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-withdrawal-list-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>limit/td>td>query/td>td>integer/td>td>false/td>td>Page limit default at 100/td>/tr>tr>td>page/td>td>query/td>td>integer/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>integer/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>transferType/td>td>query/td>td>string/td>td>false/td>td>Check for multiple transferType records, separated by commas/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>foo/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classp>,/span>span classw> /span>span classnl>currencyId/span>span classp>:/span>span classw> /span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>3000/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classw> /span>span classs2>0x12aaaaaaaa/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING_L2_APPROVING/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>chainId/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>10.0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>123/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-retrieve-user-withdrawal-list-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-retrieve-user-withdrawal-list-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» transfers/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>none/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>DEPOSIT, WITHDRAW or FAST_WITHDRAW/td>/tr>tr>td>»» CurrencyId/td>td>string/td>td>false/td>td>none/td>td>Currency ID/td>/tr>tr>td>»» Amount/td>td>string/td>td>false/td>td>none/td>td>Amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>false/td>td>none/td>td>Transaction hash/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Status/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Created at/td>/tr>tr>td>»» confirmedAt/td>td>integer/td>td>false/td>td>none/td>td>Confirmed time (only for withdrawals)/td>/tr>tr>td>»» updatedTime/td>td>string/td>td>false/td>td>none/td>td>Only applicable for deposits/td>/tr>tr>td>»» confirmedCount/td>td>string/td>td>false/td>td>none/td>td>Number of confirmations on L1, only for deposits/td>/tr>tr>td>»» requiredCount/td>td>string/td>td>false/td>td>none/td>td>Number of confirmations required for deposits on L1, only for deposits/td>/tr>tr>td>»» clientId/td>td>string/td>td>false/td>td>none/td>td>client create the Randomized id (only for withdrawal)/td>/tr>tr>td>»» orderId/td>td>string/td>td>true/td>td>none/td>td>Success Wallet Transaction Id/td>/tr>tr>td>»» chainId/td>td>string/td>td>false/td>td>none/td>td>Supported chainId/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Fee/td>/tr>tr>td>»» withdrawStatus/td>td>string/td>td>false/td>td>none/td>td>PENDING_L2_APPROVING,SUCCESS : Withdrawal status, search for multiple statuses separated by commas/td>/tr>tr>td>» totalSize/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idprivateapi-post-user-withdrawal>POST User Withdrawal/h2>p>code>POST /v1/create-withdrawal/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classp>};/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/create-withdrawal span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1001/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-user-withdrawal-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset (in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-user-withdrawal-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-user-withdrawal-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>id/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>type/td>/tr>/tbody>/table>h2 idprivateapi-post-user-withdrawal-to-designated-address>POST User Withdrawal to Designated Address/h2>p>code>POST /v1/create-withdrawal-to-address/code>/p>p>Transfer funds from L1 to a designated Ethereum address without registering for a corresponding StarkKey tagged to the Ethereum address./p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span>span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span>span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span>span classn>clientId/span>span classp>,/span>span classn>positionId/span>span classp>,/span>span classn>ethAddress/span>span classp>,/span>span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/create-withdrawal span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_withdrawal/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1001/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDC/span>span classp>,/span>span classn>ethAddress/span>span classo>/span>span classs>0x***/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-user-withdrawal-to-designated-address-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>Request signature/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Withdraw Amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» ethAddress/td>td>body/td>td>string/td>td>false/td>td>Withdraw only to your registered Ethereum address./td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-user-withdrawal-to-designated-address-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-user-withdrawal-to-designated-address-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>Withdrawal type/td>/tr>/tbody>/table>h2 idprivateapi-post-user-fast-withdrawal>POST User Fast Withdrawal/h2>p>code>POST /v1/fast-withdraw/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>fact/span> span classo>/span> span classn>this/span>span classo>./span>span classn>starkLib/span>span classo>./span>span classn>factRegistry/span>span classo>./span>span classn>getTransferErc20Fact/span>span classp>({/span> span classn>recipient/span>span classo>:/span> span classn>toEthAddress/span>span classp>,/span> span classn>tokenAddress/span>span classo>:/span> span classn>usdcAddress/span>span classp>,/span> span classn>tokenDecimals/span>span classo>:/span> span classm>6/span>span classp>,/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>Amount/span>span classp>,/span> span classn>salt/span>span classo>:/span> span classn>nonceFromClientId/span>span classp>(/span>span classn>clientId/span>span classp>),/span> span classp>});/span> span classk>const/span> span classn>transferToSign/span> span classo>/span> span classp>{/span> span classn>senderPositionId/span>span classo>:/span> span classn>accountId/span>span classp>,/span> span classn>receiverPositionId/span>span classo>:/span> span classn>fastWithdrawAccountId/span>span classp>,/span> span classn>receiverPublicKey/span>span classo>:/span> span classn>fastWithdrawL2Key/span>span classp>,/span> span classn>factRegistryAddress/span>span classo>:/span> span classn>fastWithdrawFactRegisterAddress/span>span classp>,/span> span classn>fact/span>span classp>,/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/fast-withdraw span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}&erc20Address{erc20Address}&fee{fee}&lpAccountId{lpAccountId}&chainId{chainId}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1002/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>)/span>span classn>fastWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>fast_withdrawal/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1002/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span>span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDC/span>span classp>,/span>span classn>fee/span>span classo>/span>span classn>feeRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>fee/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-user-fast-withdrawal-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>false/td>td>Withdrawal amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>false/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>false/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>false/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>false/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» erc20Address/td>td>body/td>td>string/td>td>false/td>td>USDC address/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>false/td>td>Fees/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>chainId/td>/tr>tr>td>» lpAccountId/td>td>body/td>td>string/td>td>false/td>td>Attach documents to retrieve fast_withdraw_account_id/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>FAST_WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-user-fast-withdrawal-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-user-fast-withdrawal-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>id/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>type/td>/tr>/tbody>/table>h2 idprivateapi-post-cross-chain-withdrawals>POST Cross-Chain Withdrawals/h2>p>code>POST /v1/cross-chain-withdraw/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>withdrawalToSign/span> span classo>/span> span classp>{/span> span classn>humanAmount/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>amount/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span> span classn>clientId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classn>fee/span>span classp>};/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/cross-chain-withdraw span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>amount{amount}&clientId{clientId}&asset{asset}&expiration{expiration}&signature{signature}&ethAddress{ethAddress}&erc20Address{erc20Address}&fee{fee}&lpAccountId{lpAccountId}&chainId{chainId}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>)/span>span classn>crossWithdrawRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>cross_chain_withdraw/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>expirationEpochSeconds/span>span classo>/span> span classn>currentTime/span>span classp>,/span>span classn>asset/span>span classo>/span>span classs>USDC/span>span classp>,/span>span classn>fee/span>span classo>/span>span classn>feeRes/span>span classp>/span>span classs>data/span>span classp>/span>span classs>fee/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-cross-chain-withdrawals-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» amount/td>td>body/td>td>string/td>td>true/td>td>Withdrawal amount/td>/tr>tr>td>» clientId/td>td>body/td>td>string/td>td>true/td>td>Unique id of the client associated with the withdrawal. Must be < 40 characters. When using the client, if not included, will be randomly generated by the client./td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Date and time at which the withdrawal expires if it has not been completed. Expiration must be at least seven days in the future./td>/tr>tr>td>» asset/td>td>body/td>td>string/td>td>true/td>td>Asset(in USDC) being withdrawn./td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>The signature for the transfer, signed with the account's STARK private key./td>/tr>tr>td>» erc20Address/td>td>body/td>td>string/td>td>true/td>td>USDC address/td>/tr>tr>td>» chainId/td>td>body/td>td>string/td>td>true/td>td>Randomized clientId/td>/tr>tr>td>» fee/td>td>body/td>td>string/td>td>true/td>td>Fees/td>/tr>tr>td>» lpAccountId/td>td>body/td>td>string/td>td>true/td>td>Attach documents to retrieve fast_withdraw_account_id/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234455/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CROSS_WITHDRAW/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-cross-chain-withdrawals-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-cross-chain-withdrawals-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>Withdrawal type/td>/tr>/tbody>/table>h2 idprivateapi-get-fast-amp-cross-chain-withdrawal-fees>GET Fast & Cross-Chain Withdrawal Fees/h2>p>code>GET /v1/uncommon-withdraw-fee/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/uncommon-withdraw-fee?amountspan classo>{/span>amountspan classo>}/span>&chainIdspan classo>{/span>chainIdspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>feeRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>uncommon_withdraw_fee/span>span classp>(/span>span classn>amount/span>span classo>/span>span classs>1003/span>span classp>,/span>span classn>chainId/span>span classo>/span>span classs>56/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-fast-amp-cross-chain-withdrawal-fees-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>amount/td>td>query/td>td>string/td>td>false/td>td>USDC/td>/tr>tr>td>chainId/td>td>query/td>td>string/td>td>false/td>td>chainId/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>1.1/span>span classp>,/span>span classw> /span>span classnl>poolAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>10/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-fast-amp-cross-chain-withdrawal-fees-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-fast-amp-cross-chain-withdrawal-fees-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» fee/td>td>string/td>td>true/td>td>none/td>td>Fees calculated/td>/tr>tr>td>» poolAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Available balance in pool/td>/tr>/tbody>/table>h2 idprivateapi-get-withdrawal-amp-transfer-limits>GET Withdrawal & Transfer Limits/h2>p>code>GET /v1/transfer-limit/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/transfer-limit span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>transfer_limitRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>transfer_limit/span>span classp>(/span>span classn>currencyId/span>span classo>/span>span classs>USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-withdrawal-amp-transfer-limits-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>currencyId/td>td>query/td>td>string/td>td>true/td>td>USDC/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>withdrawAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classp>,/span>span classw> /span>span classnl>transferAvailableAmount/span>span classp>:/span>span classw> /span>span classs2>100.1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-withdrawal-amp-transfer-limits-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-withdrawal-amp-transfer-limits-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» withdrawAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Withdraw available amount/td>/tr>tr>td>» transferAvailableAmount/td>td>string/td>td>true/td>td>none/td>td>Transfer available amount/td>/tr>/tbody>/table>h2 idprivateapi-get-trade-history>GET Trade History/h2>p>code>GET /v1/fills/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/fills?limitspan classo>/span>100&pagespan classo>/span>0&symbolspan classo>/span>BTC-USDC&sidespan classo>/span>BUY span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> /code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>fillsRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>fills/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classn>Type/span> span classs>UNKNOWN_ORDER_TYPE/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>h3 idprivateapi-get-trade-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default at 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>orderType/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-trade-history-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-trade-history-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total order size/td>/tr>/tbody>/table>h2 idprivateapi-get-worst-price>GET Worst Price/h2>p>code>GET /v1/get-worst-price/code>/p>p>get market price from orderbook /p>h3 idprivateapi-get-worst-price-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>size/td>td>query/td>td>string/td>td>true/td>td>Order open size/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>true/td>td>BUY or SELL order/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>worstPrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>bidOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classp>,/span>span classw> /span>span classnl>askOnePrice/span>span classp>:/span>span classw> /span>span classs2>123.00/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-worst-price-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-worst-price-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» worstPrice/td>td>string/td>td>true/td>td>none/td>td>Lowest price/td>/tr>tr>td>» bidOnePrice/td>td>string/td>td>true/td>td>none/td>td>Bid price/td>/tr>tr>td>» askOnePrice/td>td>string/td>td>true/td>td>none/td>td>Ask price/td>/tr>/tbody>/table>h2 idprivateapi-post-creating-orders>POST Creating Orders/h2>p>code>POST /v1/create-order/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Signature/span> span classn>content/span>span classo>:/span> span classn>orderToSign/span>span classo>:/span> span classn>OrderWithClientId/span> span classo>/span> span classp>{/span> span classn>humanSize/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>size/span>span classp>,/span> span classn>humanPrice/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>price/span>span classp>,/span> span classn>limitFee/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>limitFee/span>span classp>,/span> span classn>symbol/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>symbol/span>span classp>,/span> span classn>side/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>side/span>span classp>,/span> span classn>expirationIsoTimestamp/span>span classo>:/span> span classn>params/span>span classo>./span>span classn>expiration/span>span classp>,/span>span classn>clientOrderId/span>span classp>,/span> span classn>positionId/span>span classp>,/span> span classp>};/span> span classn>TimeInForce/span> span classp>(/span> span classn>GOOD_TIL_CANCEL/span> span classc>// Effective until canceled, default. /span>span classn>FILL_OR_KILL/span> span classc>// Immediately and completely filled or canceled. /span>span classn>IMMEDIATE_OR_CANCEL/span> span classc>// Immediately executed or canceled. /span>span classp>)/span> /code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/create-order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{symbol}&side{side}&type{type}&size{size}&price{price}&limitFee{limitFee}&expiration{expiration}&timeInForce{timeInForce}&triggerPrice{triggerPrice}&trailingPercent{trailingPercent}&clientOrderId{clientOrderId}&signature{signature}&reduceOnlyfalse/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private_stark_key_sign/span> span classkn>import/span> span classn>HttpPrivateStark/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>public_key/span> span classo>/span> span classs>0x1cf0000000000/span>span classn>public_key_y_coordinate/span> span classo>/span> span classs>0x7615000000000/span>span classn>private_key/span> span classo>/span> span classs>0x488a6000000000/span>span classn>client/span> span classo>/span> span classn>HttpPrivateStark/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>stark_public_key/span>span classo>/span>span classn>public_key/span>span classp>,/span> span classn>stark_private_key/span>span classo>/span>span classn>private_key/span>span classp>,/span> span classn>stark_public_key_y_coordinate/span>span classo>/span>span classn>public_key_y_coordinate/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span> span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>currentTime/span> span classo>/span> span classn>time/span>span classp>./span>span classn>time/span>span classp>()/span>span classn>createOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>create_order/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span> span classn>side/span>span classo>/span>span classs>BUY/span>span classp>,/span> span classnb>type/span>span classo>/span>span classs>LIMIT/span>span classp>,/span> span classn>size/span>span classo>/span>span classs>0.01/span>span classp>,/span> span classn>price/span>span classo>/span>span classs>20001/span>span classp>,/span> span classn>limitFee/span>span classo>/span>span classs>0.001/span>span classp>,/span> span classn>accountId/span>span classo>/span>span classs>330547708362228116/span>span classp>,/span>span classn>reduceOnly/span>span classo>/span>span classbp>False/span>span classp>,/span> span classn>expirationEpochSeconds/span>span classo>/span> span classn>currentTime/span>span classp>,/span> span classn>timeInForce/span>span classo>/span>span classs>GOOD_TIL_CANCEL/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-creating-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>Symbol/td>/tr>tr>td>» side/td>td>body/td>td>string/td>td>true/td>td>BUY or SELL/td>/tr>tr>td>» type/td>td>body/td>td>string/td>td>true/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT", "TAKE_PROFIT_MARKET"/td>/tr>tr>td>» size/td>td>body/td>td>string/td>td>true/td>td>Size/td>/tr>tr>td>» price/td>td>body/td>td>string/td>td>true/td>td>Price/td>/tr>tr>td>» limitFee/td>td>body/td>td>string/td>td>true/td>td>limitFee price * size * takerFeeRate( from GET /v1/account)/td>/tr>tr>td>» expiration/td>td>body/td>td>string/td>td>true/td>td>Order expiry time/td>/tr>tr>td>» timeInForce/td>td>body/td>td>string/td>td>false/td>td>"GOOD_TIL_CANCEL", "FILL_OR_KILL", "IMMEDIATE_OR_CANCEL", "POST_ONLY"/td>/tr>tr>td>» triggerPrice/td>td>body/td>td>string/td>td>false/td>td>Trigger price/td>/tr>tr>td>» trailingPercent/td>td>body/td>td>string/td>td>false/td>td>Conditional order trailing-stop/td>/tr>tr>td>» clientOrderId/td>td>body/td>td>string/td>td>true/td>td>Randomized client id/td>/tr>tr>td>» signature/td>td>body/td>td>string/td>td>true/td>td>starkKey signature/td>/tr>tr>td>» reduceOnly/td>td>body/td>td>string/td>td>false/td>td>Reduce-only/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-creating-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-creating-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-post-cancel-order>POST Cancel Order/h2>p>code>POST /v1/delete-order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/delete-order span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-cancel-order-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-cancel-order-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-cancel-order-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-post-cancel-order-by-clientorderid>POST Cancel Order By ClientOrderId/h2>p>code>POST /v1/delete-client-order-id/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/delete-client-order-idspan classsb>`/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>id{id}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_order_by_client_order_id/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-cancel-order-by-clientorderid-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» id/td>td>body/td>td>string/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-cancel-order-by-clientorderid-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-cancel-order-by-clientorderid-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>/tbody>/table>h2 idprivateapi-get-open-orders>GET Open Orders/h2>p>code>GET /v1/open-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>openOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>open_orders/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-open-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-open-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-open-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-post-cancel-all-open-orders>POST Cancel all Open Orders/h2>p>code>POST /v1/delete-open-orders/code>/p>blockquote>p>Body Request Parameters/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>BTC-USDC,ETH-USDC/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/delete-open-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs1>symbol{BTC-USDC,ETH-USDC}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>deleteOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>delete_open_orders/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC,ETH-USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-post-cancel-all-open-orders-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>false/td>td>"BTC-USDC,ETH-USDC", Cancel all orders if none/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-post-cancel-all-open-orders-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-cancel-all-open-orders-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>h2 idprivateapi-get-all-order-history>GET All Order History/h2>p>code>GET /v1/history-orders/code>/p>div classhighlight>pre classhighlight go tab-go>code>span classn>Order/span> span classk>type/span> span classs>UNKNOWN_ORDER_TYPE/span>span classp>,/span> span classs>LIMIT/span>span classp>,/span> span classc>//Limit price /span> span classs>MARKET/span>span classp>,/span> span classc>//Market price /span> span classs>STOP_LIMIT/span>span classp>,/span> span classc>//Stop limit order /span> span classs>STOP_MARKET/span>span classp>,/span> span classc>//Stop market order /span> span classs>TAKE_PROFIT_LIMIT/span>span classp>,/span>span classc>//Take profit limit orders /span> span classs>TAKE_PROFIT_MARKET/span>span classp>,/span>span classc>//Take profit market orders /span>span classn>Order/span> span classn>Status/span> span classs>PENDING/span>span classp>,/span> span classc>// Order submitted but not yet processesd /span> span classs>OPEN/span>span classp>,/span> span classc>// Order pending, partially filled /span> span classs>FILLED/span>span classp>,/span> span classc>// Order has been completely filled /span> span classs>CANCELED/span>span classp>,/span> span classc>//Order is canceled and may have been partially filled. /span> span classs>EXPIRED/span>span classp>,/span> span classc>// Order has expired and may have been partially filled. /span> span classs>UNTRIGGERED/span>span classp>,/span> span classc>// Order conditions have not been triggered /span>span classn>Order/span> span classn>Cancelation/span> span classn>Reason/span> span classp>{/span> span classs>UNKNOWN_ORDER_CANCEL_REASON/span> span classc>// Unknown /span> span classs>EXPIRED/span> span classc>// Order has expired /span> span classs>USER_CANCELED/span> span classc>// User manually canceled order /span> span classs>COULD_NOT_FILL/span> span classc>// Unable to fill FOK/IOC/Post-only orders /span> span classs>REDUCE_ONLY_CANCELED/span> span classc>// Unable to fulfil reduce-only orders /span> span classs>LIQUIDATE_CANCELED/span> span classc>// Account or orders triggered liquidation resulting in automatic order cancelation /span> span classs>INTERNAL_FAILED/span> span classc>// Internal processing issues including order matching failure or L2 validation failure /span>span classp>}/span>/code>/pre>/div>blockquote>p>example/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/history-orders span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historyOrdersRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_orders/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-all-order-history-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>BUY or SELL/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>"LIMIT", "MARKET","STOP_LIMIT", "STOP_MARKET", "TAKE_PROFIT_LIMIT","TAKE_PROFIT_MARKET"/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>default 100/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>orderType/td>td>query/td>td>string/td>td>false/td>td>"ACTIVE","CONDITION","HISTORY"/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>updatedTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>latestMatchFillPrice/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumMatchFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0.1/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>1000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-all-order-history-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-all-order-history-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» orders/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>»» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>»» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>»» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>»» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>»» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>»» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>»» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>»» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>»» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>»» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>total order size/td>/tr>/tbody>/table>h2 idprivateapi-get-order-id>GET Order ID/h2>p>code>GET /v1/get-order/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/get-order?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-order-id-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-order-id-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-order-id-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-get-order-by-clientorderid>GET Order by clientOrderId/h2>p>code>GET /v1/order-by-client-order-id"/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/order-by-client-order-id?idspan classo>{/span>span classnb>id/span>span classo>}/span> span classnt>-h/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>getOrderRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>get_order_by_client_order_id/span>span classp>(/span>span classnb>id/span>span classo>/span>span classs>123456/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-order-by-clientorderid-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>id/td>td>query/td>td>string/td>td>true/td>td>none/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>123456/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>afoo/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>18000/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>1.2/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>PENDING/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>GOOD_TIL_CANCEL/span>span classp>,/span>span classw> /span>span classnl>postOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>reason/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-order-by-clientorderid-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-order-by-clientorderid-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» id/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» orderId/td>td>string/td>td>false/td>td>none/td>td>Order id/td>/tr>tr>td>» clientOrderId/td>td>string/td>td>false/td>td>none/td>td>Client create the Randomized id/td>/tr>tr>td>» accountId/td>td>string/td>td>false/td>td>none/td>td>Account ID/td>/tr>tr>td>» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>» side/td>td>string/td>td>false/td>td>none/td>td>BUY or SELL/td>/tr>tr>td>» price/td>td>string/td>td>false/td>td>none/td>td>Order open price/td>/tr>tr>td>» limitFee/td>td>string/td>td>false/td>td>none/td>td>Order open max. fee/td>/tr>tr>td>» fee/td>td>string/td>td>false/td>td>none/td>td>Order open actual fee/td>/tr>tr>td>» triggerPrice/td>td>string/td>td>false/td>td>none/td>td>Conditional order trigger price/td>/tr>tr>td>» trailingPercent/td>td>string/td>td>false/td>td>none/td>td>Conditional order trailing-stop/td>/tr>tr>td>» size/td>td>string/td>td>false/td>td>none/td>td>Order open size/td>/tr>tr>td>» type/td>td>string/td>td>false/td>td>none/td>td>Order type/td>/tr>tr>td>» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Order create at/td>/tr>tr>td>» updatedTime/td>td>integer/td>td>false/td>td>none/td>td>Order update time/td>/tr>tr>td>» expiresAt/td>td>integer/td>td>false/td>td>none/td>td>Order expires at/td>/tr>tr>td>» status/td>td>string/td>td>false/td>td>none/td>td>Order status/td>/tr>tr>td>» timeInForce/td>td>string/td>td>false/td>td>none/td>td>Open order timeInForce/td>/tr>tr>td>» postOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Post-only order/td>/tr>tr>td>» reduceOnly/td>td>boolean/td>td>false/td>td>none/td>td>Open Reduce-only order/td>/tr>tr>td>» latestMatchFillPrice/td>td>string/td>td>false/td>td>none/td>td>Latest match fill price/td>/tr>tr>td>» cumMatchFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill size/td>/tr>tr>td>» cumMatchFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill value/td>/tr>tr>td>» cumMatchFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative match fill fee/td>/tr>tr>td>» cumSuccessFillSize/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill size/td>/tr>tr>td>» cumSuccessFillValue/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill value/td>/tr>tr>td>» cumSuccessFillFee/td>td>string/td>td>false/td>td>none/td>td>Cumulative success fill fee/td>/tr>/tbody>/table>h2 idprivateapi-get-verification-email-link>GET Verification Email Link/h2>p>code>GET /v1/verify-email/code>/p>h3 idprivateapi-get-verification-email-link-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>userId/td>td>query/td>td>string/td>td>false/td>td>User ID/td>/tr>tr>td>token/td>td>query/td>td>string/td>td>false/td>td>Authentication token/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>h3 idprivateapi-get-verification-email-link-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-verification-email-link-response-parameters>Response Parameters/h3>h2 idprivateapi-post-link-device>POST Link Device/h2>p>code>POST /v1/bind-device/code>/p>blockquote>p>Body Request Parameters/p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>deviceToken/span>span classpi>:/span> span classs>string/span>span classna>deviceType/span>span classpi>:/span> span classs>1 or /span>span classm>2/span>/code>/pre>/div>h3 idprivateapi-post-link-device-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» deviceToken/td>td>body/td>td>string/td>td>true/td>td>Device token/td>/tr>tr>td>» deviceType/td>td>body/td>td>string/td>td>true/td>td>1 (ios_firebase), 2 (android_firebase)/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>h3 idprivateapi-post-link-device-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-link-device-response-parameters>Response Parameters/h3>h2 idprivateapi-get-funding-rate>GET Funding Rate/h2>p>code>GET /v1/funding/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/funding?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span>&sidespan classo>{/span>sidespan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>fundingRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>funding/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>side/span>span classo>/span>span classs>BUY/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-funding-rate-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>none/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>Start time/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>End time/td>/tr>tr>td>side/td>td>query/td>td>string/td>td>false/td>td>Side/td>/tr>tr>td>status/td>td>query/td>td>string/td>td>false/td>td>Order status/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fundingValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USD/span>span classp>,/span>span classw> /span>span classnl>fundingValue/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>rate/span>span classp>:/span>span classw> /span>span classs2>0.0000125000/span>span classp>,/span>span classw> /span>span classnl>positionSize/span>span classp>:/span>span classw> /span>span classs2>500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>90/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classp>,/span>span classw> /span>span classnl>fundingTime/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>transactionId/span>span classp>:/span>span classw> /span>span classs2>1234556/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-funding-rate-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-funding-rate-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» fundingValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» id/td>td>string/td>td>false/td>td>none/td>td>id/td>/tr>tr>td>»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol/td>/tr>tr>td>»» fundingValue/td>td>string/td>td>false/td>td>none/td>td>Funding fee value/td>/tr>tr>td>»» rate/td>td>string/td>td>false/td>td>none/td>td>Funding rate/td>/tr>tr>td>»» positionSize/td>td>string/td>td>false/td>td>none/td>td>Open position size/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Symbol price/td>/tr>tr>td>»» side/td>td>string/td>td>false/td>td>none/td>td>Position side/td>/tr>tr>td>»» status/td>td>string/td>td>false/td>td>none/td>td>Position funding status/td>/tr>tr>td>»» fundingTime/td>td>integer/td>td>false/td>td>none/td>td>Funding fee time/td>/tr>tr>td>»» transactionId/td>td>string/td>td>false/td>td>none/td>td>Successful wallet transaction ID/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>Total size/td>/tr>/tbody>/table>h2 idprivateapi-get-user-historial-profit-and-loss>GET User Historial Profit and Loss/h2>p>code>GET /v1/historical-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/historical-pnl?limitspan classo>{/span>limitspan classo>}/span>&pagespan classo>{/span>pagespan classo>}/span>&beginTimeInclusivespan classo>{/span>beginTimeInclusivespan classo>}/span>&endTimeExclusivespan classo>{/span>endTimeExclusivespan classo>}/span>&typespan classo>{/span>span classnb>type/span>span classo>}/span>&symbolspan classo>{/span>symbolspan classo>}/span> span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historicalPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>historical_pnl/span>span classp>(/span>span classn>limit/span>span classo>/span>span classmi>100/span>span classp>,/span>span classn>page/span>span classo>/span>span classmi>0/span>span classp>,/span>span classn>beginTimeInclusive/span>span classo>/span>span classmi>1651406864000/span>span classp>,/span>span classn>endTimeExclusive/span>span classo>/span>span classmi>1657105971171/span>span classp>,/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>)/span>/code>/pre>/div>h3 idprivateapi-get-user-historial-profit-and-loss-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>beginTimeInclusive/td>td>query/td>td>string/td>td>false/td>td>StartTime/td>/tr>tr>td>endTimeExclusive/td>td>query/td>td>string/td>td>false/td>td>EndTime/td>/tr>tr>td>type/td>td>query/td>td>string/td>td>false/td>td>Position type/td>/tr>tr>td>symbol/td>td>query/td>td>string/td>td>false/td>td>Symbol/td>/tr>tr>td>page/td>td>query/td>td>string/td>td>false/td>td>Page numbers start from 0/td>/tr>tr>td>limit/td>td>query/td>td>string/td>td>false/td>td>Default at 100/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historicalPnl/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDC/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>totalPnl/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>1.0000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CLOSE_POSITION/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>totalSize/span>span classp>:/span>span classw> /span>span classmi>12/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-user-historial-profit-and-loss-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-user-historial-profit-and-loss-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historicalPnl/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» size/td>td>string/td>td>false/td>td>none/td>td>Size/td>/tr>tr>td>»» totalPnl/td>td>string/td>td>false/td>td>none/td>td>Closing profit and loss/td>/tr>tr>td>»» price/td>td>string/td>td>false/td>td>none/td>td>Price/td>/tr>tr>td>»» exitPrice/td>td>string/td>td>false/td>td>none/td>td>Closing price/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>Time/td>/tr>tr>td>»» type/td>td>string/td>td>false/td>td>none/td>td>postion type/td>/tr>tr>td>»» isLiquidate/td>td>boolean/td>td>false/td>td>none/td>td>Liquidate/td>/tr>tr>td>»» isDeleverage/td>td>boolean/td>td>false/td>td>none/td>td>ADL/td>/tr>tr>td>» totalSize/td>td>integer/td>td>true/td>td>none/td>td>none/td>/tr>/tbody>/table>h2 idprivateapi-get-yesterday-39-s-profit-amp-loss>GET Yesterday's Profit & Loss/h2>p>code>GET /v1/yesterday-pnl/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/yesterday-pnl span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>yesterdayPnlRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>yesterday_pnl/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-yesterday-39-s-profit-amp-loss-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classs2>11.11/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-yesterday-39-s-profit-amp-loss-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-yesterday-39-s-profit-amp-loss-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» data/td>td>string/td>td>true/td>td>none/td>td>Profit and loss value/td>/tr>/tbody>/table>h2 idprivateapi-get-historical-asset-value>GET Historical Asset Value/h2>p>code>GET /v1/history-value/code>/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/history-value span classnt>-H/span> span classs1>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs1>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs1>APEX-API-KEY: ***/span> span classnt>-H/span> span classs1>APEX-PASSPHRASE: ***/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>historyValueRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>history_value/span>span classp>()/span>/code>/pre>/div>h3 idprivateapi-get-historical-asset-value-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>endTime/td>td>query/td>td>int64/td>td>false/td>td>Start time/td>/tr>tr>td>startTime/td>td>query/td>td>int64/td>td>false/td>td>End time/td>/tr>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>historyValues/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>accountTotalValue/span>span classp>:/span>span classw> /span>span classs2>123.11/span>span classp>,/span>span classw> /span>span classnl>dateTime/span>span classp>:/span>span classw> /span>span classmi>1651406864000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivateapi-get-historical-asset-value-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-get-historical-asset-value-response-parameters>Response Parameters/h3>p>Status Code strong>200/strong>/p>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» historyValues/td>td>object/td>td>true/td>td>none/td>td>none/td>/tr>tr>td>»» accountTotalValue/td>td>string/td>td>false/td>td>none/td>td>Assets/td>/tr>tr>td>»» dateTime/td>td>integer/td>td>false/td>td>none/td>td>Assets date and time snapshot/td>/tr>/tbody>/table>h2 idprivateapi-post-sets-the-initial-margin-rate-of-a-contract>POST Sets the initial margin rate of a contract/h2>p>POST /v1/set-initial-margin-rate/p>div classhighlight>pre classhighlight shell tab-shell>code>curl https://pro.apex.exchange/api/v1/set-initial-margin-rate span classnt>-H/span> span classs2>Content-Type: application/x-www-form-urlencoded/span> span classnt>-H/span> span classs2>APEX-SIGNATURE: ***/span> span classnt>-H/span> span classs2>APEX-TIMESTAMP: ***/span> span classnt>-H/span> span classs2>APEX-API-KEY: ***/span> span classnt>-H/span> span classs2>APEX-PASSPHRASE: ***/span> span classnt>-X/span> POST span classnt>-d/span> span classs2>symbolBTC-USDC&initialMarginRate0.02/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>from/span> span classnn>apexpro.http_private/span> span classkn>import/span> span classn>HttpPrivate/span>span classkn>from/span> span classnn>apexpro.constants/span> span classkn>import/span> span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>NETWORKID_MAIN/span>span classn>key/span> span classo>/span> span classs>f16ddxxxxxxxxxxx/span>span classn>secret/span> span classo>/span> span classs>Kvckxxxxxxxxxxx/span>span classn>passphrase/span> span classo>/span> span classs>Yjjd1xxxxxxxxxx/span>span classn>client/span> span classo>/span> span classn>HttpPrivate/span>span classp>(/span>span classn>APEX_HTTP_MAIN/span>span classp>,/span> span classn>network_id/span>span classo>/span>span classn>NETWORKID_MAIN/span>span classp>,/span> span classn>api_key_credentials/span>span classo>/span>span classp>{/span>span classs>key/span>span classp>:/span> span classn>key/span>span classp>,/span>span classs>secret/span>span classp>:/span> span classn>secret/span>span classp>,/span> span classs>passphrase/span>span classp>:/span> span classn>passphrase/span>span classp>})/span>span classn>setInitialMarginRateRes/span> span classo>/span> span classn>client/span>span classp>./span>span classn>set_initial_margin_rate/span>span classp>(/span>span classn>symbol/span>span classo>/span>span classs>BTC-USDC/span>span classp>,/span>span classn>initialMarginRate/span>span classo>/span>span classs>0.1/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>setInitialMarginRateRes/span>span classp>)/span>/code>/pre>/div>blockquote>p>Body /p>/blockquote>div classhighlight>pre classhighlight yaml tab-yaml>code>span classna>symbol/span>span classpi>:/span> span classs>string/span>span classna>initialMarginRate/span>span classpi>:/span> span classs>string/span>/code>/pre>/div>h3 idprivateapi-post-sets-the-initial-margin-rate-of-a-contract-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Position/th>th>Type/th>th>Required/th>th>Comment/th>/tr>/thead>tbody>tr>td>APEX-SIGNATURE/td>td>header/td>td>string/td>td>true/td>td>Request signature/td>/tr>tr>td>APEX-TIMESTAMP/td>td>header/td>td>string/td>td>true/td>td>Request timestamp/td>/tr>tr>td>APEX-API-KEY/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.key/td>/tr>tr>td>APEX-PASSPHRASE/td>td>header/td>td>string/td>td>true/td>td>apiKeyCredentials.passphrase/td>/tr>tr>td>body/td>td>body/td>td>object/td>td>false/td>td>none/td>/tr>tr>td>» symbol/td>td>body/td>td>string/td>td>true/td>td>symbol/td>/tr>tr>td>» initialMarginRate/td>td>body/td>td>string/td>td>true/td>td>initialMarginRate(the reciprocal of the opening leverage)/td>/tr>/tbody>/table>blockquote>p>Successful Response Generation /p>/blockquote>h3 idprivateapi-post-sets-the-initial-margin-rate-of-a-contract-response-status-code>Response Status Code/h3>table>thead>tr>th>Status Code/th>th>Definition/th>th>Comment/th>th>Data Model/th>/tr>/thead>tbody>tr>td>200/td>td>OK/td>td>Success/td>td>Inline/td>/tr>/tbody>/table>h3 idprivateapi-post-sets-the-initial-margin-rate-of-a-contract-response-parameters>Response Parameters/h3>h1 idstarkkey-signature>StarkKey Signature/h1>p>Several endpoints require a starkKey signature authentication, please check the list below./p>h2 idstarkkey-signature-create-order>Create Order/h2>p>Refer to required signature content. /p>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>amount_collateral/span>span classp>:/span>span classw> /span>span classs2>4000000/span>span classp>,/span>span classw> /span>span classnl>amount_fee/span>span classp>:/span>span classw> /span>span classs2>4000/span>span classp>,/span>span classw> /span>span classnl>amount_synthetic/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>asset_id_collateral/span>span classp>:/span>span classw> /span>span classs2>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/span>span classp>,/span>span classw> /span>span classnl>asset_id_synthetic/span>span classp>:/span>span classw> /span>span classs2>0x0/span>span classp>,/span>span classw> /span>span classnl>expiration_timestamp/span>span classp>:/span>span classw> /span>span classs2>1100000/span>span classp>,/span>span classw> /span>span classnl>is_buying_synthetic/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1001/span>span classp>,/span>span classw> /span>span classnl>order_type/span>span classp>:/span>span classw> /span>span classs2>LIMIT_ORDER_WITH_FEES/span>span classp>,/span>span classw> /span>span classnl>position_id/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>public_key/span>span classp>:/span>span classw> /span>span classs2>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/span>span classp>,/span>span classw> /span>span classnl>signature/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>r/span>span classp>:/span>span classw> /span>span classs2>0x07a15838aad9b20368dc4ba27613fd35ceec3b34be7a2cb913bca0fb06e98107/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>0x05007f40fddd9babae0c7362d3b4e9c152ed3fced7fe78435b302d825489298f/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idstarkkey-signature-create-order-transaction-signing-amp-validation>Transaction Signing & Validation/h3>p>In ApeX Pro's testing environment, USDC is at 6 decimal places and BTC-USDC Perpetual Contract at 10 decimal places. For example, at the amount of 40,000 USDC and an open position of 0.0001 BTC with funding fee rate at 0.1%: /p>ul>li> asset_id_collateral testing environment code>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/code>br>/li>li> asset_id_synthetic testing environment where BTC-USDC is at 0x0/li>li> amount_synthetic 0.0001 (at 10 decimal places) would be equivalent to code>0.0001 * (10 ** 10) 1000000/code>br>/li>li> amount_collateral 0.0001 * 40000 4 USDC (at 6 decimal places) and would be equivalent to code>40000 * 0.0001 * (10 **6) 4000000/code>br>/li>li> amount_fee 4 * 0.1% 0.004 USDC (at 6 decimal places) and would be equivalent to code>4000000 * 0.1 / 100 4000/code>br>/li>li> expiration_timestamp: "1100000"，timeout calculated per hour, code>unix timestamp/3600/code>br>/li>li> is_buying_synthetic: buy true, sell false/li>li> nonce: "1001" and UInt32 must be the only entry — when creating orders make sure the entry for a href/#general-client_id-and-nonce-generation>generated client_Id/a> is nonce/li>/ul>p>Hash Value Calculation Reference /p>p>code>https://github.com/starkware-libs/stark-perpetual/blob/d1edb2203440b54e71458b10bf0bb646d8597caf/src/services/perpetual/public/perpetual_messages.py#L163/code> /p>h3 idstarkkey-signature-create-order-hash-value-calculation>Hash Value Calculation/h3>ul>li>p>Calculated signature hash as code>0x0375d83863bc2639f6a161dc96651a55d71d53230f9416ce66720243eda44722/code>/p>/li>li>p>postion_id 10000 /p>/li>li>p>Private Key code>0x607ba3969039f3e19006ff8f40629d20a7b7dac31d4019e0965fbf7c5c068a/code> /p>/li>li>p>Public Key code>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/code> /p>/li>/ul>p>Please refer to code>https://github.com/starkware-libs/stark-perpetual/blob/d1edb2203440b54e71458b10bf0bb646d8597caf/src/starkware/crypto/starkware/crypto/signature/signature.py#L124/code> /p>p>Transaction Signing & Validation Result: /p>ul>li>r code>07a15838aad9b20368dc4ba27613fd35ceec3b34be7a2cb913bca0fb06e98107/code>br>/li>li>s code>05007f40fddd9babae0c7362d3b4e9c152ed3fced7fe78435b302d825489298f/code>br>/li>/ul>h2 idstarkkey-signature-withdrawal>Withdrawal/h2>p>Refer to required signature content for withdrawal to individual Ethereum address. /p>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>expiration_timestamp/span>span classp>:/span>span classw> /span>span classs2>660000/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1650006339/span>span classp>,/span>span classw> /span>span classnl>position_id/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>public_key/span>span classp>:/span>span classw> /span>span classs2>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/span>span classp>,/span>span classw> /span>span classnl>signature/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>r/span>span classp>:/span>span classw> /span>span classs2>0x056a727b30d09f393acd968917bca78d92fb63a827db25747940916aa4074938/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>0x0775f575a71ff8f2c13dd522e605bd71652a709daa26db5a0f8218cc589fe8f9/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAWAL/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idstarkkey-signature-withdrawal-transaction-signing-amp-validation>Transaction Signing & Validation/h3>p>USDC has 6 decimal places; timeout is calculated in hours; unix timestamp/3600, nonce UInt32 must be the only entry for a href/#general-client_id-and-nonce-generation>generated client_Id/a>/p>ul>li> amount refers to the ：Withdrawal amount code>1 USDC 1 * (10 ** 6)/code>/li>li> expiration_timestamp:660000, timeout calculated per hour, unix timestamp/3600/li>li> nonce: 1650006339/li>li> position_id: 10000，postionID of the withdrawal account/li>/ul>p>Hash Value Calculation Reference /p>p>code>https://docs.starkware.co/starkex-v4/starkex-deep-dive/message-encodings/in-perpetual#withdrawal/code> /p>ul>li>Please note that the amount stated in the above document is incorrect, the correct amount is 64 bits/li>/ul>p>Reference code:br>code>https://github.com/starkware-libs/stark-perpetual/blob/d1edb2203440b54e71458b10bf0bb646d8597caf/src/services/perpetual/public/perpetual_messages.py#L112/code>/p>h3 idstarkkey-signature-withdrawal-hash-value-calculation>Hash Value Calculation/h3>ul>li>p>Calculated signature hash asbr>code>0x7f8ebd70332711c35e54808d16740701b902bd03fb6a004dacb9dbbc9a8932/code>/p>/li>li>p>postion_id 10000 /p>/li>li>p>Private Key code>0x607ba3969039f3e19006ff8f40629d20a7b7dac31d4019e0965fbf7c5c068a/code> /p>/li>li>p>Public Key code>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/code> /p>/li>/ul>p>Transaction Signing & Validation Result /p>ul>li>r code>0x056a727b30d09f393acd968917bca78d92fb63a827db25747940916aa4074938/code>br>/li>li>s code>0x0775f575a71ff8f2c13dd522e605bd71652a709daa26db5a0f8218cc589fe8f9/code>br>/li>/ul>h2 idstarkkey-signature-withdrawal-to-address>Withdrawal to Address/h2>p>Refer to required signature content for withdrawal endpoint WITHDRAWAL_TO_ADDRESS./p>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>eth_address/span>span classp>:/span>span classw> /span>span classs2>0x724f337bf0fa934db9aa3ec6dea49b03c54ad3cc/span>span classp>,/span>span classw> /span>span classnl>expiration_timestamp/span>span classp>:/span>span classw> /span>span classs2>660000/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1651500987/span>span classp>,/span>span classw> /span>span classnl>position_id/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>public_key/span>span classp>:/span>span classw> /span>span classs2>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/span>span classp>,/span>span classw> /span>span classnl>signature/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>r/span>span classp>:/span>span classw> /span>span classs2>0x07edcc193f142ff8c78d700774fbccde8214c21f8fc1bd190390d367ce365696/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>0x06e5b54f17f56e65e21b00e83fd2b6f3da072ed6b6df3ca50747d8a0974d5033/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>WITHDRAWAL_TO_ADDRESS/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Use a new WITHDRAWAL_TO_ADDRESS and transfer your assets from L1 to a designated Ethereum address. When requesting for a withdrawal endpoint on L1, you will need to enter eth_address in the required starkKey portion. You will not need to register a corresponding starkKey to manage the Ethereum address. /p>h3 idstarkkey-signature-withdrawal-to-address-transaction-signing-amp-validation>Transaction Signing & Validation/h3>p>USDC has 6 decimal places; timeout is calculated in hours; unix timestamp/3600, nonce UInt32 must be the only entry for a href/#general-client_id-and-nonce-generation>generated client_Id/a>/p>ul>li>amount refers to the withdrawal amount where code>1 USDC 1 * (10 ** 6)/code>/li>li>expiration_timestamp:660000, timeout calculated per hour, unix timestamp/3600/li>li>nonce: 1651500987br>/li>li>position_id: 10000，postion ID of the withdrawal account/li>li>ethaddress: code>0x724f337bf0fa934db9aa3ec6dea49b03c54ad3cc/code>br>/li>li>Hash Value Reference: WITHDRAWAL_TO_ADDRESS 7/li>/ul>h3 idstarkkey-signature-withdrawal-to-address-hash-value-calculation>Hash Value Calculation/h3>div classhighlight>pre classhighlight python tab-python>code>span classk>def/span> span classnf>get_withdrawal_to_address_msg/span>span classp>(/span> span classn>asset_id_collateral/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>position_id/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>eth_address/span>span classp>:/span> span classnb>str/span>span classp>,/span> span classn>nonce/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>expiration_timestamp/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>amount/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>hash_function/span>span classp>:/span> span classn>Callable/span>span classp>/span>span classn>VarArg/span>span classp>(/span>span classnb>int/span>span classp>),/span> span classnb>int/span>span classp>/span> span classo>/span> span classn>pedersen_hash/span>span classp>,/span>span classp>)/span> span classo>->/span> span classnb>int/span>span classp>:/span> span classk>assert/span> span classmi>0/span> span classo> span classn>asset_id_collateral/span> span classo> span classmi>2/span> span classo>**/span> span classmi>250/span> span classk>assert/span> span classmi>0/span> span classo> span classn>nonce/span> span classo> span classmi>2/span> span classo>**/span> span classmi>32/span> span classk>assert/span> span classmi>0/span> span classo> span classn>position_id/span> span classo> span classmi>2/span> span classo>**/span> span classmi>64/span> span classk>assert/span> span classmi>0/span> span classo> span classn>expiration_timestamp/span> span classo> span classmi>2/span> span classo>**/span> span classmi>32/span> span classk>assert/span> span classmi>0/span> span classo> span classn>amount/span> span classo> span classmi>2/span> span classo>**/span> span classmi>64/span> span classk>assert/span> span classmi>0/span> span classo> span classnb>int/span>span classp>(/span>span classn>eth_address/span>span classp>,/span> span classmi>16/span>span classp>)/span> span classo> span classmi>2/span> span classo>**/span> span classmi>160/span> span classk>return/span> span classn>get_withdrawal_to_address_msg_without_bounds/span>span classp>(/span> span classn>asset_id_collateral/span>span classp>,/span> span classn>position_id/span>span classp>,/span> span classn>eth_address/span>span classp>,/span> span classn>nonce/span>span classp>,/span> span classn>expiration_timestamp/span>span classp>,/span> span classn>amount/span>span classp>,/span> span classn>hash_function/span>span classo>/span>span classn>hash_function/span>span classp>,/span> span classp>)/span>span classk>def/span> span classnf>get_withdrawal_to_address_msg_without_bounds/span>span classp>(/span> span classn>asset_id_collateral/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>position_id/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>eth_address/span>span classp>:/span> span classnb>str/span>span classp>,/span> span classn>nonce/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>expiration_timestamp/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>amount/span>span classp>:/span> span classnb>int/span>span classp>,/span> span classn>hash_function/span>span classp>:/span> span classn>Callable/span>span classp>/span>span classn>VarArg/span>span classp>(/span>span classnb>int/span>span classp>),/span> span classnb>int/span>span classp>/span> span classo>/span> span classn>pedersen_hash/span>span classp>,/span>span classp>)/span> span classo>->/span> span classnb>int/span>span classp>:/span> span classn>eth_address_int/span> span classo>/span> span classnb>int/span>span classp>(/span>span classn>eth_address/span>span classp>,/span> span classmi>16/span>span classp>)/span> span classn>packed_message/span> span classo>/span> span classn>WITHDRAWAL_TO_ADDRESS/span> span classn>packed_message/span> span classo>/span> span classn>packed_message/span> span classo>*/span> span classmi>2/span> span classo>**/span> span classmi>64/span> span classo>+/span> span classn>position_id/span> span classn>packed_message/span> span classo>/span> span classn>packed_message/span> span classo>*/span> span classmi>2/span> span classo>**/span> span classmi>32/span> span classo>+/span> span classn>nonce/span> span classn>packed_message/span> span classo>/span> span classn>packed_message/span> span classo>*/span> span classmi>2/span> span classo>**/span> span classmi>64/span> span classo>+/span> span classn>amount/span> span classn>packed_message/span> span classo>/span> span classn>packed_message/span> span classo>*/span> span classmi>2/span> span classo>**/span> span classmi>32/span> span classo>+/span> span classn>expiration_timestamp/span> span classn>packed_message/span> span classo>/span> span classn>packed_message/span> span classo>*/span> span classmi>2/span> span classo>**/span> span classmi>49/span> span classc1># Padding./span> span classk>return/span> span classn>hash_function/span>span classp>(/span>span classn>hash_function/span>span classp>(/span>span classn>asset_id_collateral/span>span classp>,/span> span classn>eth_address_int/span>span classp>),/span> span classn>packed_message/span>span classp>)/span>/code>/pre>/div>ul>li>p>Calculated signature hash:br>code>0x0367fa833e40d36df56df501502fe80eabf4d7f3da99169865a38fa6e3d2482c/code> /p>/li>li>p>postion_id 10000 /p>/li>li>p>Private Key code>0x607ba3969039f3e19006ff8f40629d20a7b7dac31d4019e0965fbf7c5c068a/code> /p>/li>li>p>Public Key code>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/code> /p>/li>/ul>p>Transaction Signing & Validation Result /p>ul>li>r code>0x07edcc193f142ff8c78d700774fbccde8214c21f8fc1bd190390d367ce365696/code>br>/li>li>s code>0x06e5b54f17f56e65e21b00e83fd2b6f3da072ed6b6df3ca50747d8a0974d5033/code>br>/li>/ul>h2 idstarkkey-signature-cross-chain-withdrawal>Cross-Chain Withdrawal/h2>p>Refer to required signature content for this transfer endpoint, utilized for cross-chain deposits. /p>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>asset_id/span>span classp>:/span>span classw> /span>span classs2>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/span>span classp>,/span>span classw> /span>span classnl>expiration_timestamp/span>span classp>:/span>span classw> /span>span classs2>660000/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1652361581/span>span classp>,/span>span classw> /span>span classnl>receiver_position_id/span>span classp>:/span>span classw> /span>span classs2>30000/span>span classp>,/span>span classw> /span>span classnl>receiver_public_key/span>span classp>:/span>span classw> /span>span classs2>0x2f116d013fb6ecae90765a876a5bfcf66cd6a6be1f85c9841629cd0bd080ed3/span>span classp>,/span>span classw> /span>span classnl>sender_position_id/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>sender_public_key/span>span classp>:/span>span classw> /span>span classs2>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/span>span classp>,/span>span classw> /span>span classnl>signature/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>r/span>span classp>:/span>span classw> /span>span classs2>0xd4c14bb7bfd66785352c8b57c3864722e2137f51299e0a21dff495759c3902/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>0x01a7dcd09583e3261906ad1f039848e9ace4d3cc988e56e96bb8652e9c483517/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>TRANSFER/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idstarkkey-signature-cross-chain-withdrawal-transaction-signing-amp-validation>Transaction Signing & Validation/h3>p>USDC has 6 decimal places; timeout is calculated in hours; unix timestamp/3600, nonce UInt32 must be the only entry for a href/#general-client_id-and-nonce-generation>generated client_Id/a>/p>ul>li>amount refers to the transfer amount where code>1 USDC 1 * (10 ** 6)/code>/li>li>asset_id : asset_id for USDC on L2 in testing environment as code>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/code>br>/li>li>expiration_timestamp:660000, timeout calculated per hour, unix timestamp/3600/li>li>nonce: 1652361581br>/li>li>receiver_position_id : 30000，postion ID of the recipient account/li>li>receiver_public_key : starkKey of the recipient account /li>li>sender_position_id: 10000，postion ID of the sender account /li>li>sender_public_key: starkKey of the sender account/li>/ul>p>Hash Value Reference (TRANSFER 4)br>code>https://github.com/starkware-libs/stark-perpetual/blob/d1edb2203440b54e71458b10bf0bb646d8597caf/src/services/perpetual/public/perpetual_messages.py#L69/code> /p>ul>li>Please note that asset_id_fee and max_amount_fee are 0 by default and you will need to enter src_fee_position_id into sender_position_id.br>/li>/ul>h3 idstarkkey-signature-cross-chain-withdrawal-hash-value-calculation>Hash Value Calculation/h3>ul>li>p>Calculated signature hashbr>code>0x0146e4cf2bfe86e8333a08f6e56f6d78debcffd393625b2d34e2e0c95c493540/code>/p>/li>li>p>postion_id 10000 /p>/li>li>p>Private Key code>0x607ba3969039f3e19006ff8f40629d20a7b7dac31d4019e0965fbf7c5c068a/code>/p>/li>li>p>Public Key code>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/code>/p>/li>/ul>p>Transaction Signing & Validation Result /p>ul>li>r code>0xd4c14bb7bfd66785352c8b57c3864722e2137f51299e0a21dff495759c3902/code>br>/li>li>s code>0x01a7dcd09583e3261906ad1f039848e9ace4d3cc988e56e96bb8652e9c483517/code>br>/li>/ul>h2 idstarkkey-signature-conditional-transfer>Conditional Transfer/h2>p>Refer to required signature content for this CONDITIONAL_TRANSFER endpoint, utilized for Fast Withdrawals./p>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classs2>1000000/span>span classp>,/span>span classw> /span>span classnl>asset_id/span>span classp>:/span>span classw> /span>span classs2>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/span>span classp>,/span>span classw> /span>span classnl>expiration_timestamp/span>span classp>:/span>span classw> /span>span classs2>660000/span>span classp>,/span>span classw> /span>span classnl>fact/span>span classp>:/span>span classw> /span>span classs2>d7262d40a59d8bd081382e506f94230c73e3b81dc464bb02e7314b1afcca46d1/span>span classp>,/span>span classw> /span>span classnl>fact_registry_address/span>span classp>:/span>span classw> /span>span classs2>0x5070F5d37419AEAd10Df2252421e457336561269/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classs2>1652361582/span>span classp>,/span>span classw> /span>span classnl>receiver_position_id/span>span classp>:/span>span classw> /span>span classs2>20000/span>span classp>,/span>span classw> /span>span classnl>receiver_public_key/span>span classp>:/span>span classw> /span>span classs2>0x2deb04eb807be0ec943e08d8f666521edb3f12833922fbbc7f93e1434ae810e/span>span classp>,/span>span classw> /span>span classnl>sender_position_id/span>span classp>:/span>span classw> /span>span classs2>10000/span>span classp>,/span>span classw> /span>span classnl>sender_public_key/span>span classp>:/span>span classw> /span>span classs2>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/span>span classp>,/span>span classw> /span>span classnl>signature/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>r/span>span classp>:/span>span classw> /span>span classs2>0x07dbf7b64406bd4de0439dfd79a742d1703ce44b99dfbe5a99d792c11447a952/span>span classp>,/span>span classw> /span>span classnl>s/span>span classp>:/span>span classw> /span>span classs2>0x01c436232f1e938cdcfe661f580d6957cdbdb72a14e66021349dd6c2baa6ac36/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>CONDITIONAL_TRANSFER/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idstarkkey-signature-conditional-transfer-transaction-signing-amp-validation>Transaction Signing & Validation/h3>p>USDC has 6 decimal places; timeout is calculated in hours; unix timestamp/3,600, nonce UInt32 must be the only entry for a href/#general-client_id-and-nonce-generation>generated client_Id/a> /p>ul>li>amount refers to the transfer amount where code>1 USDC 1 * (10 ** 6)/code>/li>li>asset_id :asset_id for USDC on L2 in testing environment asbr>code>0xa21edc9d9997b1b1956f542fe95922518a9e28ace11b7b2972a1974bf5971f/code>br>/li>li>expiration_timestamp: 660000, timeout calculated per hour, unix timestamp/3600/li>li>nonce: 1652361581 /li>li>receiver_position_id: 30000, postion ID of the recipient account/li>li>receiver_public_key: starkKey of the recipient account/li>li>sender_position_id: 10000，postion ID of the sender account/li>li>sender_public_key: starkKey of the sender account/li>li>fact: L1 fact hash value/li>li>fact_registry_address: L1 fact registered contract address/li>/ul>p>Hash Value Reference (CondTransferType 5)br>code>https://github.com/starkware-libs/stark-perpetual/blob/d1edb2203440b54e71458b10bf0bb646d8597caf/src/services/perpetual/public/perpetual_messages.py#L24/code> /p>ul>li>Please note that asset_id_fee and max_amount_fee are 0 at default and you will need to enter src_fee_position_id into sender_position_id. /li>/ul>h3 idstarkkey-signature-conditional-transfer-hash-value-calculation>Hash Value Calculation/h3>ul>li>p>Calculated signature hash ascode>0x9677d1aee45206f66b46826de80b25ad06ce58c09c63adc5f65e04c4a5da90/code> /p>/li>li>p>postion_id 10000 /p>/li>li>p>Private Key code>0x607ba3969039f3e19006ff8f40629d20a7b7dac31d4019e0965fbf7c5c068a/code>/p>/li>li>p>Public Key code>0xf8c6635f9cfe85f46759dc2eebe71a45b765687e35dbe5e74e8bde347813ef/code>/p>/li>/ul>p>Transaction Signing & Validation Result /p>ul>li>r code>0x07dbf7b64406bd4de0439dfd79a742d1703ce44b99dfbe5a99d792c11447a952/code>/li>li>s code>0x01c436232f1e938cdcfe661f580d6957cdbdb72a14e66021349dd6c2baa6ac36/code>br>/li>/ul>h1 idwebsocket-v3-for-omni>Websocket V3 for Omni/h1>h2 idwebsocket-v3-for-omni-websocket-v3-endpoint>Websocket V3 Endpoint:/h2>p>code>Timestamp Current Unix Timestamp/code>/p>h3 idwebsocket-v3-for-omni-websocket-v3-endpoint-testnet>Testnet:/h3>p>Public Websocket APIbr>code>wss://qa-quote.omni.apex.exchange/realtime_public?v2&timestamp1661415017232/code> /p>p>Private Websocket APIbr>code>wss://qa-quote.omni.pro.apex.exchange/realtime_private?v2&timestamp1661415017233/code>/p>h3 idwebsocket-v3-for-omni-websocket-v3-endpoint-mainnet>Mainnet:/h3>p>Public Websocket APIbr>code>wss://quote.omni.apex.exchange/realtime_public?v2&timestamp1661415017232/code> /p>p>Private Websocket APIbr>code>wss://quote.omni.apex.exchange/realtime_private?v2&timestamp1661415017233/code>/p>h1 idpublic-websocket-v3>Public Websocket V3/h1>p>Due to network complexity, your may get disconnected at any time. Please follow the instructions below to ensure that you receive WebSocket messages on time:- Keep connection alive by sending heartbeat packetbr>- Reconnect as soon as possible if disconnected /p>h2 idpublic-websocket-v3-heartbeat-packet>Heartbeat Packet/h2>p>To avoid networks or program issues, we recommend that you send the ping heartbeat packet every 15 seconds to maintain the WebSocket connection. /p>blockquote>p>How to Send/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:ping,args:1661415022821}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>Response Example/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classdl>/span>span classs1>{op:pong,args:1661415030233}/span>span classdl>/span>/code>/pre>/div>p>When receiving a ping message from the server, a pong message needs to be returned to the server./p>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:pong,args:1661415022821}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>p>Server Check With Ping Pong Test:br>- Check the connection ever 15 seconds and look at the client timestampbr>- If the difference between the client timestamp and the current timestamp exceeds 150s, the connection will be closed /p>h2 idpublic-websocket-v3-how-to-subscribe-to-topics>How to Subscribe to Topics/h2>h3 idpublic-websocket-v3-how-to-subscribe-to-topics-understanding-websocket-filters>Understanding Websocket Filters/h3>p>After establishing the connection, one can subscribe to a new topic by sending a JSON request. The specific formats are as follows: /p>blockquote>p>ws.send('{"op": "subscribe", "args": "topic.filter"}'); /p>/blockquote>p>The topic indicates the data you would like to receive whilst the filter parses for the specific data you desire, for example, the symbol. The topic is mandatory but the filter is optional.br>To subscribe to more than one topic, simply list multiple topics out like this: /p>blockquote>p>ws.send('{"op": "subscribe", "args": "topic.filter", "topic.filter"}');/p>/blockquote>h3 idpublic-websocket-v3-how-to-subscribe-to-topics-unsubscribing-from-websocket-topics>Unsubscribing From Websocket Topics/h3>p>You can dynamically subscribe and unsubscribe from topics (with or without filters) without websocket disconnection as follows: /p>blockquote>p>ws.send('{"op": "unsubscribe", "args": "topic.filter", "topic.filter"}');/p>/blockquote>h3 idpublic-websocket-v3-how-to-subscribe-to-topics-intervals>Intervals/h3>p>Some topics are pushed out at specific intervals. If the args contains a millisecond parameter, such as 100ms, this topic is pushed at intervals. Otherwise, topis will be pushed constantly. /p>h3 idpublic-websocket-v3-how-to-subscribe-to-topics-understanding-subscription-response>Understanding Subscription Response/h3>p>Each subscription will have a response. You can determine whether the subscription is successful based on the response. /p>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>success/span>span classdl>/span>span classp>:/span>span classkc>true/span>span classp>,/span> span classdl>/span>span classs2>ret_msg/span>span classdl>/span>span classp>:/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>conn_id/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>647c3de8-6f66-44ab-a323-72067589372e/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>request/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>subscribe/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs2>instrumentInfo.H.BTCUSDT/span>span classdl>/span> span classp>/span> span classp>}/span>span classp>}/span>/code>/pre>/div>h2 idpublic-websocket-v3-depth>Depth/h2>p>Fetches the orderbook with a depth of 25 or 200 orders per side. /p>p>After the subscription response, the first response will be the snapshot response. This shows the entire order book. The data is sorted by price, starting with the lowest buys and ending with the highest sells. /p>p>Following this, all responses are in the delta format, which represents updates to the order book relative to the last response. /p>h3 idpublic-websocket-v3-depth-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Order book/td>/tr>tr>td>» limit/td>td>string/td>td>true/td>td>25 or 200/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:orderBook200.H.BTCUSDT}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>orderBook200.H.BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>delta/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>b/span>span classdl>/span>span classp>:/span> span classp>/span> span classdl>/span>span classs2>18990.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>,/span> span classp>/span> span classdl>/span>span classs2>18979.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>/span> span classp>,/span> span classdl>/span>span classs2>a/span>span classdl>/span>span classp>:/span> span classp>/span> span classdl>/span>span classs2>19010.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>,/span> span classp>/span> span classdl>/span>span classs2>19037.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>/span> span classp>,/span> span classdl>/span>span classs2>u/span>span classdl>/span>span classp>:/span>span classmi>249003/span> span classp>},/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44132980/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661416027956272/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v3-depth-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>» s/td>td>string/td>td>Symbol/td>/tr>tr>td>» u/td>td>int/td>td>Update ID: According to whether the Update ID is continuous, the client will need to determine if there is a packet loss in the process of receiving data. Snapshot resets the Update ID and it will start counting again from 1./td>/tr>tr>td>» b/td>td>array/td>td>Buyprice,size, size set as 0 will delete this item/td>/tr>tr>td>» a/td>td>array/td>td>Sellprice,size, size set as 0 will delete this item/td>/tr>/tbody>/table>h2 idpublic-websocket-v3-trade>Trade/h2>p>Get Trades for symbol./p>p>TickDirection {br>"PlusTick"br>"ZeroPlusTick"br>"MinusTick"br>"ZeroMinusTick"br>}/p>h3 idpublic-websocket-v3-trade-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Recently trade/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:recentlyTrade.H.BTCUSDT}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>recentlyTrade.H.BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>T/span>span classdl>/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCPERP/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>S/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>Buy/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1.000/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>43513.00/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>L/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>PlusTick/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>i/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>a3afbef7-d8de-5b87-a32f-d06f041a249d/span>span classdl>/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44132980/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661416027956272/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v3-trade-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot/td>/tr>tr>td>» s/td>td>string/td>td>Symbol/td>/tr>tr>td>» T/td>td>int/td>td>Timestamp/td>/tr>tr>td>» S/td>td>string/td>td>Buy or Sell/td>/tr>tr>td>» v/td>td>string/td>td>Volume/td>/tr>tr>td>» p/td>td>string/td>td>Price/td>/tr>tr>td>» L/td>td>string/td>td>Tick direction/td>/tr>tr>td>» i/td>td>string/td>td>Order ID/td>/tr>/tbody>/table>h2 idpublic-websocket-v3-ticker>Ticker/h2>p>Get latest information for symbol. /p>p>This topic only utilizes the update field. Both the delete and insert fields are null. If a key is not found in the update field, its value has not changed. /p>h3 idpublic-websocket-v3-ticker-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Instrument info/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:instrumentInfo.H.BTCUSDT}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>instrumentInfo.H.BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>symbol/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>lastPrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21572.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>price24hPcnt/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0194318181818182/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>highPrice24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>25306.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>lowPrice24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>17001.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>turnover24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1334891.4545/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>volume24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>64.896/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>nextFundingTime/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>2022-08-26T08:00:00Z/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>oraclePrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21412.060000000002752512/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>indexPrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21409.82/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>openInterest/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>49.598/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tradeCount/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fundingRate/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>predictedFundingRate/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span> span classp>},/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44939063/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661500091955487/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v3-ticker-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» price24hPcnt/td>td>string/td>td>24H change (%)/td>/tr>tr>td>»» lastPrice/td>td>string/td>td>Last price/td>/tr>tr>td>»» highPrice24h/td>td>string/td>td>24H highest price/td>/tr>tr>td>»» lowPrice24h/td>td>string/td>td>24H lowest price/td>/tr>tr>td>»» oraclePrice/td>td>string/td>td>Oracle price/td>/tr>tr>td>»» indexPrice/td>td>string/td>td>Index price/td>/tr>tr>td>»» openInterest/td>td>string/td>td>Open interest/td>/tr>tr>td>»» turnover24h/td>td>string/td>td>24H turnover/td>/tr>tr>td>»» volume24h/td>td>string/td>td>24H trading volume/td>/tr>tr>td>»» fundingRate/td>td>string/td>td>Funding rate/td>/tr>tr>td>»» predictedFundingRate/td>td>string/td>td>Predicted funding rate/td>/tr>tr>td>»» nextFundingTime/td>td>string/td>td>Next funding rate/td>/tr>tr>td>»» tradeCount/td>td>string/td>td>24H trade count/td>/tr>/tbody>/table>h2 idpublic-websocket-v3-candlestick-chart>Candlestick Chart/h2>p>Currently supported intervals: /p>ul>li>1 3 5 15 30br>/li>li>60 120 240 360 720br>/li>li>Dbr>/li>li>Wbr>/li>li>Mbr>/li>/ul>p>If code>confirm/code> is true, this will indicate the last ticker price within the specified interval. /p>h3 idpublic-websocket-v3-candlestick-chart-request>request/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Candle/td>/tr>tr>td>» interval/td>td>string/td>td>true/td>td>Interval/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:candle.1.BTCUSDT}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response data/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>candle.1.BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>start/span>span classdl>/span>span classp>:/span>span classmi>1647511440000/span>span classp>,/span> span classdl>/span>span classs2>end/span>span classdl>/span>span classp>:/span>span classmi>1647511499999/span>span classp>,/span> span classdl>/span>span classs2>interval/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>open/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>close/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>high/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>low/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>volume/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>turnover/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>confirm/span>span classdl>/span>span classp>:/span>span classkc>true/span>span classp>,/span> span classdl>/span>span classs2>time/span>span classdl>/span>span classp>:/span>span classmi>1647511500752/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1647511500752/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v3-candlestick-chart-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>»» start/td>td>integer/td>td>Start time/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» interval/td>td>string/td>td>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W"/td>/tr>tr>td>»» low/td>td>string/td>td>Low price/td>/tr>tr>td>»» high/td>td>string/td>td>High price/td>/tr>tr>td>»» open/td>td>string/td>td>Open price/td>/tr>tr>td>»» close/td>td>string/td>td>Close price/td>/tr>tr>td>»» volume/td>td>string/td>td>Trading volume/td>/tr>tr>td>»» turnover/td>td>string/td>td>Turnover/td>/tr>tr>td>»» confirm/td>td>string/td>td>If it is the last tick of this candle/td>/tr>tr>td>»» time/td>td>string/td>td>Current time/td>/tr>/tbody>/table>h2 idpublic-websocket-v3-all-tickers>All Tickers/h2>p>Get latest information for all symbols./p>p>This topic only utilizes the update field. Both the delete and insert fields are null. If a key is not found in the update field, its value has not changed./p>h3 idpublic-websocket-v3-all-tickers-request>Request/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Instrument info/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:instrumentInfo.all}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>instrumentInfo.all/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>LINKUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.966/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0510829587249694/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>7.401/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.931/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.966/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.965/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>37279.7137/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5128.7/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5647.1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21572.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0194318181818182/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>25306.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>17001.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21412.060000000002752512/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21409.83/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1334891.4545/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>64.858/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>49.598/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ETHUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1680.45/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0150631538844767/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1805.65/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1680.45/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1654.64/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1654.1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>664502.346/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>389.16/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>375.87/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>DOGEUSDT/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0621/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.1013024602026049/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.1481/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0501/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>mp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.06773/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0677/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5007.69/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>70977/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>43216/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661500091389816/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v3-all-tickers-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>»» s/td>td>string/td>td>Symbol/td>/tr>tr>td>»» pr/td>td>string/td>td>24H change (%)/td>/tr>tr>td>»» p/td>td>string/td>td>Last price/td>/tr>tr>td>»» h/td>td>string/td>td>24H highest price/td>/tr>tr>td>»» l/td>td>string/td>td>24H lowest price/td>/tr>tr>td>»» mp/td>td>string/td>td>Mark price/td>/tr>tr>td>»» xp/td>td>string/td>td>Index price/td>/tr>tr>td>»» o/td>td>string/td>td>Open interest/td>/tr>tr>td>»» to/td>td>string/td>td>24H turnover/td>/tr>tr>td>»» v/td>td>string/td>td>24H trading volume/td>/tr>tr>td>»» fr/td>td>string/td>td>Funding rate/td>/tr>tr>td>»» tc/td>td>string/td>td>24H trade count/td>/tr>/tbody>/table>h1 idprivate-websocket-v3>Private Websocket V3/h1>h2 idprivate-websocket-v3-send-authority-request>Send Authority Request/h2>ul>li>Use apiKeyCredentials.secret sign, the rule as code/li>li>The topic can be subscribed to during authentication/li>li>Send authority request/li>li>After each successful subscription, the client will receive the snapshot (full data)/li>li>Type : snapshot means full data, delta means incremental data. If it is none, type will default to snapshot./li>/ul>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>const/span> span classnx>apiKeyCredentials/span> span classo>/span> span classp>{/span>span classdl>/span>span classs2>key/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>f6c1e736-fa6b-01df-2822-b9359b3918ae/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>secret/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>sAVchdqy_n9zY7TOIDsqkyg0we3uF0_gGbvyIoob/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>passphrase/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>Ri08mFrOt2Uaiym/span>span classdl>/span>span classp>}/span>span classkd>const/span> span classnx>timestamp/span> span classo>/span> span classmi>1647502440973/span>span classp>;/span>span classkd>const/span> span classnx>request_path/span> span classo>/span> span classdl>/span>span classs1>/ws/accounts/span>span classdl>/span>span classp>;/span>span classkd>const/span> span classnx>http_method/span> span classo>/span> span classdl>/span>span classs1>GET/span>span classdl>/span>span classp>;/span>span classkd>const/span> span classnx>messageString/span>span classp>:/span> span classnx>string/span> span classo>/span> span classp>(/span> span classnx>timestamp/span> span classo>+/span> span classnx>http_method/span> span classo>+/span> span classnx>request_path/span>span classp>);/span>span classkd>const/span> span classnx>key/span> span classo>/span> span classnx>Buffer/span>span classp>./span>span classk>from/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>apiKeyCredentials/span>span classp>./span>span classnx>secret/span>span classp>)./span>span classnx>toString/span>span classp>(/span>span classdl>/span>span classs1>base64/span>span classdl>/span>span classp>);/span>span classkd>const/span> span classnx>hash/span> span classo>/span> span classnx>cryptojs/span>span classp>./span>span classnx>HmacSHA256/span>span classp>(/span>span classnx>messageString/span>span classp>,/span> span classnx>key/span>span classp>);/span>span classkd>const/span> span classnx>signature/span> span classo>/span> span classnx>hash/span>span classp>./span>span classnx>toString/span>span classp>(/span>span classnx>cryptojs/span>span classp>./span>span classnx>enc/span>span classp>./span>span classnx>Base64/span>span classp>);/span>span classc1>//auth sign/span>span classkd>const/span> span classnx>req/span> span classo>/span> span classp>{/span> span classdl>/span>span classs1>type/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs1>login/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>topics/span>span classdl>/span>span classp>:/span> span classp>/span>span classdl>/span>span classs1>ws_notify_v1/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs1>ws_zk_accounts_v3/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>httpMethod/span>span classdl>/span>span classp>:/span>span classnx>http_method/span>span classp>,/span> span classdl>/span>span classs1>requestPath/span>span classdl>/span>span classp>:/span>span classnx>request_path/span>span classp>,/span> span classdl>/span>span classs1>apiKey/span>span classdl>/span>span classp>:/span> span classnx>apiKeyCredentials/span>span classp>/span>span classdl>/span>span classs1>key/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>passphrase/span>span classdl>/span>span classp>:/span> span classnx>apiKeyCredentials/span>span classp>/span>span classdl>/span>span classs1>passphrase/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>timestamp/span>span classdl>/span>span classp>:/span> span classnx>timestamp/span>span classp>,/span> span classdl>/span>span classs1>signature/span>span classdl>/span>span classp>:/span> span classnx>signature/span>span classp>,/span>span classp>}/span>span classnx>sendStr/span> span classo>/span> span classp>{/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs2>login/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span> span classp>/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>req/span>span classp>)/span> span classp>}/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>sendStr/span>span classp>));/span>span classc1>//add subscribe/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>({/span>span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>subscribe/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ws_zk_accounts_v3/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>ws_notify_v1/span>span classdl>/span>span classp>}));/span>span classc1>//cancel subscribe/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>({/span>span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>unsubscribe/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ws_zk_accounts_v3/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>ws_notify_v1/span>span classdl>/span>span classp>});/span>/code>/pre>/div>p>Response Errors： /p>ul>li>p>request param errorbr>code>{"success":false,"ret_msg":"msg param error","conn_id":"xxxxxxxxxxsasad"}/code> /p>/li>li>p>user authority errorbr>code>{"success":false,"ret_msg":"login authority err,"conn_id":"xxxxxxxxxxsasad"}/code> /p>/li>/ul>h2 idprivate-websocket-v3-subscription-success-push-data>Subscription Success Push Data/h2>div classhighlight>pre classhighlight json tab-json>code>span classw> /span>span classp>{/span>span classw> /span>span classnl>contractAccounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>0x711df5ffc57b033b22c65e38e4b3d8b1947eaee7403aaa4ff5847d31ca0b0700/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1717953051513/span>span classp>,/span>span classw> /span>span classnl>makerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00000000/span>span classp>,/span>span classw> /span>span classnl>takerFeeRate/span>span classp>:/span>span classw> /span>span classs2>0.00025/span>span classp>,/span>span classw> /span>span classnl>unrealizePnlPriceType/span>span classp>:/span>span classw> /span>span classs2>MARKET_PRICE/span>span classp>,/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>1213724853023293440/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718452222267/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>spotWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>28994.971947673600000001/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>1213724853023293440/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>spotAccounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1717128570381/span>span classp>,/span>span classw> /span>span classnl>subAccounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>l2Key/span>span classp>:/span>span classw> /span>span classs2>0x711df5ffc57b033b22c65e38e4b3d8b1947eaee7403aaa4ff5847d31ca0b0700/span>span classp>,/span>span classw> /span>span classnl>nonceVersion/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>changePubKeyStatus/span>span classp>:/span>span classw> /span>span classs2>FINISH/span>span classp>,/span>span classw> /span>span classnl>subAccountId/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>10/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>defaultSubAccountId/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>zkAccountId/span>span classp>:/span>span classw> /span>span classs2>229/span>span classp>,/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classw> /span>span classs2>1213724853023293440/span>span classp>,/span>span classw> /span>span classnl>ethAddress/span>span classp>:/span>span classw> /span>span classs2>0xc4c5036b68a42d8f1c6ba9ba8e5dd49ad5c1ef5c/span>span classp>,/span>span classw> /span>span classnl>nonce/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718789127665/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>NORMAL/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positionClosedTransactions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>cumSuccessLiquidateFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>openSlParams/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>triggerSize/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_PRICE_TYPE/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>STOP_MARKET/span>span classp>,/span>span classw> /span>span classnl>isPositionTpsl/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1718104870661/span>span classp>,/span>span classw> /span>span classnl>isSetOpenTp/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>52200.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>588326929847812444/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_ORDER_CANCEL_REASON/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>IMMEDIATE_OR_CANCEL/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718104870661/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>0.270000000000000000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>4171300479007599/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>58000/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>MARKET/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1720523854/span>span classp>,/span>span classw> /span>span classnl>openTpParams/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>triggerSize/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_PRICE_TYPE/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.010/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isSetOpenSl/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classw> /span>span classs2>0.010/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>UNTRIGGERED/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>cumSuccessLiquidateFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>openSlParams/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>triggerSize/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_PRICE_TYPE/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>TAKE_PROFIT_MARKET/span>span classp>,/span>span classw> /span>span classnl>isPositionTpsl/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classw> /span>span classmi>1718104870651/span>span classp>,/span>span classw> /span>span classnl>isSetOpenTp/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classw> /span>span classs2>86900.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>588326929805869404/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_ORDER_CANCEL_REASON/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classw> /span>span classs2>IMMEDIATE_OR_CANCEL/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718104870651/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classw> /span>span classs2>0.440000000000000000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SELL/span>span classp>,/span>span classw> /span>span classnl>clientId/span>span classp>:/span>span classw> /span>span classs2>8086734464495621/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>79000/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>MARKET/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classw> /span>span classmi>1720523854/span>span classp>,/span>span classw> /span>span classnl>openTpParams/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>triggerSize/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>triggerPriceType/span>span classp>:/span>span classw> /span>span classs2>UNKNOWN_PRICE_TYPE/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.010/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>isSetOpenSl/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classw> /span>span classs2>0.010/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>UNTRIGGERED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>openValue/span>span classp>:/span>span classw> /span>span classs2>710.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>sumOpen/span>span classp>:/span>span classw> /span>span classs2>0.011/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>-2.094765226613730193/span>span classp>,/span>span classw> /span>span classnl>sumClose/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>64545.454545454545454545/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>customImr/span>span classp>:/span>span classw> /span>span classs2>0.05000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.011/span>span classp>,/span>span classw> /span>span classnl>realizedPnl/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718104870634/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>SHORT/span>span classp>,/span>span classw> /span>span classnl>openValue/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>sumOpen/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>fundingFee/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>sumClose/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classw> /span>span classs2>584232029671915612/span>span classp>,/span>span classw> /span>span classnl>customImr/span>span classp>:/span>span classw> /span>span classs2>0.05000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classw> /span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>realizedPnl/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classw> /span>span classmi>1718099221473/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>experienceMoney/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>totalAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>totalNumber/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>recycledAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>availableAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>contractWallets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classw> /span>span classs2>281.891287099786269807/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>0.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>token/span>span classp>:/span>span classw> /span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>deleverages/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classw> /span>span classs2>BTC-USDT/span>span classp>,/span>span classw> /span>span classnl>lightNumber/span>span classp>:/span>span classw> /span>span classs2>5/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classw> /span>span classs2>LONG/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivate-websocket-v3-subscription-success-push-data-response-parameters>Response Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Required/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» contents/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» contractAccounts/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» l2Key/td>td>string/td>td>false/td>td>none/td>td>User's account l2Key/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>User's account ID/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>User's account create time/td>/tr>tr>td>»»» makerFeeRate/td>td>string/td>td>false/td>td>none/td>td>Maker fee rate/td>/tr>tr>td>»»» takerFeeRate/td>td>string/td>td>false/td>td>none/td>td>Taker fee rate/td>/tr>tr>td>»»» unrealizePnlPriceType/td>td>string/td>td>false/td>td>none/td>td>User unrealize Pnl price type, as 'MARKET_PRICE'/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User's user ID/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>false/td>td>none/td>td>User's account update time/td>/tr>tr>td>»»» status/td>td>string/td>td>false/td>td>none/td>td>User's account status/td>/tr>tr>td>»» spotWallets/td>td>object/td>td>true/td>td>none/td>td>User's spot account/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>User's account ID/td>/tr>tr>td>»»» pendingDepositAmount/td>td>string/td>td>false/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»»» subAccountId/td>td>string/td>td>false/td>td>none/td>td>User's sub account ID/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Asset balance/td>/tr>tr>td>»»» pendingWithdrawAmount/td>td>string/td>td>false/td>td>none/td>td>Pending withdraw amount/td>/tr>tr>td>»»» pendingTransferInAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer in amount/td>/tr>tr>td>»»» pendingTransferOutAmount/td>td>string/td>td>false/td>td>none/td>td>Pending transfer out amount/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User's user ID/td>/tr>tr>td>»»» token/td>td>string/td>td>false/td>td>none/td>td>Asset token name/td>/tr>tr>td>»» spotAccounts/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» accountId/td>td>string/td>td>false/td>td>none/td>td>User's account ID/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>false/td>td>none/td>td>User's spot account create time/td>/tr>tr>td>»»» subAccounts/td>td>object/td>td>false/td>td>none/td>td>User's sub accounts/td>/tr>tr>td>»»»» l2Key/td>td>string/td>td>false/td>td>none/td>td>User's sub account l2Key/td>/tr>tr>td>»»»» nonceVersion/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce version/td>/tr>tr>td>»»»» changePubKeyStatus/td>td>string/td>td>false/td>td>none/td>td>User's sub account change pubKey status/td>/tr>tr>td>»»»» subAccountId/td>td>string/td>td>false/td>td>none/td>td>User's sub account ID/td>/tr>tr>td>»»»» nonce/td>td>integer/td>td>false/td>td>none/td>td>User's sub account nonce/td>/tr>tr>td>»»» defaultSubAccountId/td>td>string/td>td>false/td>td>none/td>td>User's zk default sub account ID/td>/tr>tr>td>»»» zkAccountId/td>td>string/td>td>false/td>td>none/td>td>User's zk account ID/td>/tr>tr>td>»»» userId/td>td>string/td>td>false/td>td>none/td>td>User's user ID/td>/tr>tr>td>»»» ethAddress/td>td>string/td>td>false/td>td>none/td>td>User's ethereum address/td>/tr>tr>td>»»» nonce/td>td>integer/td>td>false/td>td>none/td>td>User's account nonce/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>false/td>td>none/td>td>User's account update time/td>/tr>tr>td>»»» status/td>td>string/td>td>false/td>td>none/td>td>User's account status/td>/tr>tr>td>»» transfers/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» positionClosedTransactions/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»» orders/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» cumSuccessLiquidateFee/td>td>string/td>td>true/td>td>none/td>td>Cumulative liquidate fee/td>/tr>tr>td>»»» symbol/td>td>string/td>td>true/td>td>none/td>td>Symbol/td>/tr>tr>td>»»» openSlParams/td>td>object/td>td>true/td>td>none/td>td>Open Sl order params/td>/tr>tr>td>»»»» triggerSize/td>td>string/td>td>true/td>td>none/td>td>Order trigger size/td>/tr>tr>td>»»»» triggerPrice/td>td>string/td>td>true/td>td>none/td>td>Order trigger price/td>/tr>tr>td>»»»» triggerPriceType/td>td>string/td>td>true/td>td>none/td>td>Order trigger type/td>/tr>tr>td>»»» cumSuccessFillFee/td>td>string/td>td>true/td>td>none/td>td>Cumulative fill fee/td>/tr>tr>td>»»» type/td>td>string/td>td>true/td>td>none/td>td>order type/td>/tr>tr>td>»»» isPositionTpsl/td>td>boolean/td>td>true/td>td>none/td>td>If the order is position Tpsl/td>/tr>tr>td>»»» isDeleverage/td>td>boolean/td>td>true/td>td>none/td>td>If the order is deleverage/td>/tr>tr>td>»»» createdAt/td>td>integer/td>td>true/td>td>none/td>td>The order created time/td>/tr>tr>td>»»» isSetOpenTp/td>td>boolean/td>td>true/td>td>none/td>td>If the order is set open Tp/td>/tr>tr>td>»»» price/td>td>string/td>td>true/td>td>none/td>td>Order Price/td>/tr>tr>td>»»» cumSuccessFillValue/td>td>string/td>td>true/td>td>none/td>td>Cumulative fill value/td>/tr>tr>td>»»» id/td>td>string/td>td>true/td>td>none/td>td>Order ID/td>/tr>tr>td>»»» cancelReason/td>td>string/td>td>true/td>td>none/td>td>Order cancel reason/td>/tr>tr>td>»»» timeInForce/td>td>string/td>td>true/td>td>none/td>td>Order timeInForce/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>true/td>td>none/td>td>Order updated time/td>/tr>tr>td>»»» limitFee/td>td>string/td>td>true/td>td>none/td>td>Order limit fee/td>/tr>tr>td>»»» side/td>td>string/td>td>true/td>td>none/td>td>Order side/td>/tr>tr>td>»»» clientId/td>td>string/td>td>true/td>td>none/td>td>Order client ID/td>/tr>tr>td>»»» triggerPrice/td>td>string/td>td>true/td>td>none/td>td>Condition order trigger price/td>/tr>tr>td>»»» triggerPriceType/td>td>string/td>td>true/td>td>none/td>td>Condition order trigger type/td>/tr>tr>td>»»» expiresAt/td>td>integer/td>td>true/td>td>none/td>td>Order expired time/td>/tr>tr>td>»»» openTpParams/td>td>object/td>td>true/td>td>none/td>td>Open Tp order params/td>/tr>tr>td>»»»» triggerSize/td>td>string/td>td>true/td>td>none/td>td>Order trigger size/td>/tr>tr>td>»»»» triggerPrice/td>td>string/td>td>true/td>td>none/td>td>Order trigger price/td>/tr>tr>td>»»»» triggerPriceType/td>td>string/td>td>true/td>td>none/td>td>Order trigger type/td>/tr>tr>td>»»» cumSuccessFillSize/td>td>string/td>td>true/td>td>none/td>td>umulative fill size/td>/tr>tr>td>»»» size/td>td>string/td>td>true/td>td>none/td>td>Order size/td>/tr>tr>td>»»» reduceOnly/td>td>boolean/td>td>true/td>td>none/td>td>If the order is reduce only/td>/tr>tr>td>»»» isSetOpenSl/td>td>boolean/td>td>true/td>td>none/td>td>If the order is set open Sl/td>/tr>tr>td>»»» isLiquidate/td>td>boolean/td>td>true/td>td>none/td>td>If the order is liquidate/td>/tr>tr>td>»»» remainingSize/td>td>string/td>td>true/td>td>none/td>td>The order remaining size/td>/tr>tr>td>»»» status/td>td>string/td>td>true/td>td>none/td>td>The order's status/td>/tr>tr>td>»» positions/td>td>object/td>td>true/td>td>none/td>td>Open positions/td>/tr>tr>td>»»» symbol/td>td>string/td>td>true/td>td>none/td>td>Symbol/td>/tr>tr>td>»»» exitPrice/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» side/td>td>string/td>td>true/td>td>none/td>td>Side/td>/tr>tr>td>»»» openValue/td>td>string/td>td>true/td>td>none/td>td>Position open value/td>/tr>tr>td>»»» sumOpen/td>td>string/td>td>true/td>td>none/td>td>Position cumulative opened size/td>/tr>tr>td>»»» fundingFee/td>td>string/td>td>true/td>td>none/td>td>Position funding fee/td>/tr>tr>td>»»» sumClose/td>td>string/td>td>true/td>td>none/td>td>Position cumulative closed size/td>/tr>tr>td>»»» entryPrice/td>td>string/td>td>true/td>td>none/td>td>Position cumulative entry price/td>/tr>tr>td>»»» accountId/td>td>string/td>td>true/td>td>none/td>td>User's account ID/td>/tr>tr>td>»»» customImr/td>td>string/td>td>true/td>td>none/td>td>Symbol's custom initial margin rate/td>/tr>tr>td>»»» size/td>td>string/td>td>true/td>td>none/td>td>Position size/td>/tr>tr>td>»»» realizedPnl/td>td>string/td>td>true/td>td>none/td>td>Postion realized Pnl/td>/tr>tr>td>»»» updatedAt/td>td>integer/td>td>true/td>td>none/td>td>Postion update time/td>/tr>tr>td>»» experienceMoney/td>td>object/td>td>true/td>td>none/td>td>Experience money/td>/tr>tr>td>»»» totalAmount/td>td>string/td>td>false/td>td>none/td>td>Total experience money value/td>/tr>tr>td>»»» totalNumber/td>td>string/td>td>false/td>td>none/td>td>Total experience money number/td>/tr>tr>td>»»» recycledAmount/td>td>string/td>td>false/td>td>none/td>td>Recycled experience money value/td>/tr>tr>td>»»» availableAmount/td>td>string/td>td>false/td>td>none/td>td>Available experience money amount/td>/tr>tr>td>»»» token/td>td>string/td>td>false/td>td>none/td>td>Experience money token/td>/tr>tr>td>»» contractWallets/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» pendingDepositAmount/td>td>string/td>td>false/td>td>none/td>td>Pending deposit amount/td>/tr>tr>td>»»» balance/td>td>string/td>td>false/td>td>none/td>td>Wallet balance/td>/tr>tr>td>»»» pendingWithdrawAmount/td>td>string/td>td>false/td>td>none/td>td>Pending withdrawal amount/td>/tr>tr>td>»»» pendingTransferInAmount/td>td>string/td>td>false/td>td>none/td>td>Pending inbound transfer amount/td>/tr>tr>td>»»» pendingTransferOutAmount/td>td>string/td>td>false/td>td>none/td>td>Pending outbound transfer amount/td>/tr>tr>td>»»» token/td>td>string/td>td>false/td>td>none/td>td>Asset token name/td>/tr>tr>td>»» deleverages/td>td>object/td>td>true/td>td>none/td>td>/td>/tr>tr>td>»»» symbol/td>td>string/td>td>false/td>td>none/td>td>Symbol name/td>/tr>tr>td>»»» lightNumber/td>td>string/td>td>false/td>td>none/td>td>ADL ranking/td>/tr>tr>td>»»» side/td>td>string/td>td>false/td>td>none/td>td>Open side/td>/tr>tr>td>»» fills/td>td>string/td>td>true/td>td>none/td>td>Fills/td>/tr>tr>td>» topic/td>td>string/td>td>true/td>td>none/td>td>Subscribe topic/td>/tr>tr>td>» type/td>td>string/td>td>true/td>td>none/td>td>/td>/tr>tr>td>» timestamp/td>td>integer/td>td>true/td>td>none/td>td>Message time/td>/tr>/tbody>/table>h2 idprivate-websocket-v3-order-submission-push>Order Submission Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>PENDING/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-post-submission-of-maker-order-push>Post-Submission of Maker Order Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>OPEN/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-post-cancel-order-push>Post-Cancel Order Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>CANCELED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-successful-order-execution-push>Successful Order Execution Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classw>/span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>liquidity/span>span classp>:/span>span classs2>TAKER/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521361/span>span classp>,/span>span classw> /span>span classnl>isOpen/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>quoteAmount/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048000182272/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185678345/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>maxSize/span>span classp>:/span>span classs2>2820.000/span>span classp>,/span>span classw> /span>span classnl>sumOpen/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>sumClose/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>netFunding/span>span classp>:/span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classs2>2500.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652179377769/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>realizedPnl/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>closedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDT/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>FILLED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-deposit-success-push>Deposit Success Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classs2>438.486000/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classs2>USDT/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-withdrawal-request-submission-push>Withdrawal Request Submission Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classw>/span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_zk_accounts_v3/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>QUEUED/span>span classp>,/span>span classw> /span>span classnl>transactionId/span>span classp>:/span>span classs2>39190120/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>89abf9d72432/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>WITHDRAWAL/span>span classp>,/span>span classw> /span>span classnl>creditAsset/span>span classp>:/span>span classs2>USDT/span>span classp>,/span>span classw> /span>span classnl>creditAmount/span>span classp>:/span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1647502440973/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v3-notify-message-push>Notify Message Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>contents/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>unreadNum/span>span classp>:/span>span classw> /span>span classmi>24/span>span classp>,/span>span classw> /span>span classnl>notifyMsgList/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1145486332832022528/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>lang/span>span classp>:/span>span classw> /span>span classs2>en/span>span classp>,/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classs2>Deposit success /span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classs2>Your deposit of 100.000000 USDT has been confirmed./span>span classp>,/span>span classw> /span>span classnl>androidLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iosLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>webLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>read/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>1682357834534/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classw> /span>span classs2>ws_notify_v1/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>snapshot/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivate-websocket-v3-notify-message-push-response-parameters>Response Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» notifyMsgList/td>td>object/td>td>Notification message list/td>/tr>tr>td>»» id/td>td>string/td>td>Notification ID/td>/tr>tr>td>»» category/td>td>int/td>td>Notification category/td>/tr>tr>td>»» lang/td>td>string/td>td>Language/td>/tr>tr>td>»» title/td>td>string/td>td>Title/td>/tr>tr>td>»» content/td>td>string/td>td>Content/td>/tr>tr>td>»» androidLink/td>td>string/td>td>Android link/td>/tr>tr>td>»» iosLink/td>td>string/td>td>Ios link/td>/tr>tr>td>»» webLink/td>td>string/td>td>Web link/td>/tr>tr>td>»» read/td>td>bool/td>td>If notification has been read/td>/tr>tr>td>»» createdTime/td>td>int/td>td>Created time/td>/tr>/tbody>/table>h2 idprivate-websocket-v3-new-notification-message-push>New Notification Message Push/h2>blockquote>p>Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>contents/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>notify_list/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1145486332832022528/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>NOTIFY_CATEGORY_ACCOUNT/span>span classp>,/span>span classw> /span>span classnl>lang/span>span classp>:/span>span classw> /span>span classs2>en/span>span classp>,/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classs2>Deposit success /span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classs2>Your deposit of 100.000000 USDT has been confirmed./span>span classp>,/span>span classw> /span>span classnl>androidLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iosLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>webLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>read/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>1682357834534/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classw> /span>span classs2>ws_notify_v1/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>delta/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 idwebsocket-v2-for-pro>Websocket V2 for Pro/h1>h2 idwebsocket-v2-for-pro-websocket-endpoint>Websocket Endpoint:/h2>p>code>Timestamp Current Unix Timestamp/code>/p>h3 idwebsocket-v2-for-pro-websocket-endpoint-testnet>Testnet:/h3>p>Public Websocket APIbr>code>wss://quote-testnet.pro.apex.exchange/realtime_public?v2&timestamp1661415017232/code> /p>p>Private Websocket APIbr>code>wss://quote-testnet.pro.apex.exchange/realtime_private?v2&timestamp1661415017233/code>/p>h3 idwebsocket-v2-for-pro-websocket-endpoint-mainnet>Mainnet:/h3>p>Public Websocket APIbr>code>wss://quote.pro.apex.exchange/realtime_public?v2&timestamp1661415017232/code> /p>p>Private Websocket APIbr>code>wss://quote.pro.apex.exchange/realtime_private?v2&timestamp1661415017233/code>/p>h1 idpublic-websocket-v2>Public Websocket V2/h1>p>Due to network complexity, your may get disconnected at any time. Please follow the instructions below to ensure that you receive WebSocket messages on time:- Keep connection alive by sending heartbeat packetbr>- Reconnect as soon as possible if disconnected /p>h2 idpublic-websocket-v2-heartbeat-packet>Heartbeat Packet/h2>p>To avoid networks or program issues, we recommend that you send the ping heartbeat packet every 15 seconds to maintain the WebSocket connection. /p>blockquote>p>How to Send/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:ping,args:1661415022821}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>Response Example/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classdl>/span>span classs1>{op:pong,args:1661415030233}/span>span classdl>/span>/code>/pre>/div>p>When receiving a ping message from the server, a pong message needs to be returned to the server./p>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:pong,args:1661415022821}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>p>Server Check With Ping Pong Test:br>- Check the connection ever 15 seconds and look at the client timestampbr>- If the difference between the client timestamp and the current timestamp exceeds 150s, the connection will be closed /p>h2 idpublic-websocket-v2-how-to-subscribe-to-topics>How to Subscribe to Topics/h2>h3 idpublic-websocket-v2-how-to-subscribe-to-topics-understanding-websocket-filters>Understanding Websocket Filters/h3>p>After establishing the connection, one can subscribe to a new topic by sending a JSON request. The specific formats are as follows: /p>blockquote>p>ws.send('{"op": "subscribe", "args": "topic.filter"}'); /p>/blockquote>p>The topic indicates the data you would like to receive whilst the filter parses for the specific data you desire, for example, the symbol. The topic is mandatory but the filter is optional.br>To subscribe to more than one topic, simply list multiple topics out like this: /p>blockquote>p>ws.send('{"op": "subscribe", "args": "topic.filter", "topic.filter"}');/p>/blockquote>h3 idpublic-websocket-v2-how-to-subscribe-to-topics-unsubscribing-from-websocket-topics>Unsubscribing From Websocket Topics/h3>p>You can dynamically subscribe and unsubscribe from topics (with or without filters) without websocket disconnection as follows: /p>blockquote>p>ws.send('{"op": "unsubscribe", "args": "topic.filter", "topic.filter"}');/p>/blockquote>h3 idpublic-websocket-v2-how-to-subscribe-to-topics-intervals>Intervals/h3>p>Some topics are pushed out at specific intervals. If the args contains a millisecond parameter, such as 100ms, this topic is pushed at intervals. Otherwise, topis will be pushed constantly. /p>h3 idpublic-websocket-v2-how-to-subscribe-to-topics-understanding-subscription-response>Understanding Subscription Response/h3>p>Each subscription will have a response. You can determine whether the subscription is successful based on the response. /p>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>success/span>span classdl>/span>span classp>:/span>span classkc>true/span>span classp>,/span> span classdl>/span>span classs2>ret_msg/span>span classdl>/span>span classp>:/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>conn_id/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>647c3de8-6f66-44ab-a323-72067589372e/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>request/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>subscribe/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs2>instrumentInfo.H.BTCUSDC/span>span classdl>/span> span classp>/span> span classp>}/span>span classp>}/span>/code>/pre>/div>h2 idpublic-websocket-v2-depth>Depth/h2>p>Fetches the orderbook with a depth of 25 or 200 orders per side. /p>p>After the subscription response, the first response will be the snapshot response. This shows the entire order book. The data is sorted by price, starting with the lowest buys and ending with the highest sells. /p>p>Following this, all responses are in the delta format, which represents updates to the order book relative to the last response. /p>h3 idpublic-websocket-v2-depth-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Order book/td>/tr>tr>td>» limit/td>td>string/td>td>true/td>td>25 or 200/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:orderBook200.H.BTCUSDC}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>orderBook200.H.BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>delta/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>b/span>span classdl>/span>span classp>:/span> span classp>/span> span classdl>/span>span classs2>18990.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>,/span> span classp>/span> span classdl>/span>span classs2>18979.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>/span> span classp>,/span> span classdl>/span>span classs2>a/span>span classdl>/span>span classp>:/span> span classp>/span> span classdl>/span>span classs2>19010.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>,/span> span classp>/span> span classdl>/span>span classs2>19037.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span> span classp>/span> span classp>,/span> span classdl>/span>span classs2>u/span>span classdl>/span>span classp>:/span>span classmi>249003/span> span classp>},/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44132980/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661416027956272/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v2-depth-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>» s/td>td>string/td>td>Symbol/td>/tr>tr>td>» u/td>td>int/td>td>Update ID: According to whether the Update ID is continuous, the client will need to determine if there is a packet loss in the process of receiving data. Snapshot resets the Update ID and it will start counting again from 1./td>/tr>tr>td>» b/td>td>array/td>td>Buyprice,size, size set as 0 will delete this item/td>/tr>tr>td>» a/td>td>array/td>td>Sellprice,size, size set as 0 will delete this item/td>/tr>/tbody>/table>h2 idpublic-websocket-v2-trade>Trade/h2>p>Get Trades for symbol./p>p>TickDirection {br>"PlusTick"br>"ZeroPlusTick"br>"MinusTick"br>"ZeroMinusTick"br>}/p>h3 idpublic-websocket-v2-trade-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Recently trade/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:recentlyTrade.H.BTCUSDC}/span>span classdl>/span>span classp>);/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>recentlyTrade.H.BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>T/span>span classdl>/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCPERP/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>S/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>Buy/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1.000/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>43513.00/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>L/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>PlusTick/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>i/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>a3afbef7-d8de-5b87-a32f-d06f041a249d/span>span classdl>/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44132980/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661416027956272/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v2-trade-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot/td>/tr>tr>td>» s/td>td>string/td>td>Symbol/td>/tr>tr>td>» T/td>td>int/td>td>Timestamp/td>/tr>tr>td>» S/td>td>string/td>td>Buy or Sell/td>/tr>tr>td>» v/td>td>string/td>td>Volume/td>/tr>tr>td>» p/td>td>string/td>td>Price/td>/tr>tr>td>» L/td>td>string/td>td>Tick direction/td>/tr>tr>td>» i/td>td>string/td>td>Order ID/td>/tr>/tbody>/table>h2 idpublic-websocket-v2-ticker>Ticker/h2>p>Get latest information for symbol. /p>p>This topic only utilizes the update field. Both the delete and insert fields are null. If a key is not found in the update field, its value has not changed. /p>h3 idpublic-websocket-v2-ticker-request-parameters>Request Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Instrument info/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:instrumentInfo.H.BTCUSDC}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>instrumentInfo.H.BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:{/span> span classdl>/span>span classs2>symbol/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>lastPrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21572.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>price24hPcnt/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0194318181818182/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>highPrice24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>25306.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>lowPrice24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>17001.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>turnover24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1334891.4545/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>volume24h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>64.896/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>nextFundingTime/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>2022-08-26T08:00:00Z/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>oraclePrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21412.060000000002752512/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>indexPrice/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21409.82/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>openInterest/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>49.598/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tradeCount/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fundingRate/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>predictedFundingRate/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span> span classp>},/span> span classdl>/span>span classs2>cs/span>span classdl>/span>span classp>:/span>span classmi>44939063/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661500091955487/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v2-ticker-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» price24hPcnt/td>td>string/td>td>24H change (%)/td>/tr>tr>td>»» lastPrice/td>td>string/td>td>Last price/td>/tr>tr>td>»» highPrice24h/td>td>string/td>td>24H highest price/td>/tr>tr>td>»» lowPrice24h/td>td>string/td>td>24H lowest price/td>/tr>tr>td>»» oraclePrice/td>td>string/td>td>Oracle price/td>/tr>tr>td>»» indexPrice/td>td>string/td>td>Index price/td>/tr>tr>td>»» openInterest/td>td>string/td>td>Open interest/td>/tr>tr>td>»» turnover24h/td>td>string/td>td>24H turnover/td>/tr>tr>td>»» volume24h/td>td>string/td>td>24H trading volume/td>/tr>tr>td>»» fundingRate/td>td>string/td>td>Funding rate/td>/tr>tr>td>»» predictedFundingRate/td>td>string/td>td>Predicted funding rate/td>/tr>tr>td>»» nextFundingTime/td>td>string/td>td>Next funding rate/td>/tr>tr>td>»» tradeCount/td>td>string/td>td>24H trade count/td>/tr>/tbody>/table>h2 idpublic-websocket-v2-candlestick-chart>Candlestick Chart/h2>p>Currently supported intervals: /p>ul>li>1 3 5 15 30br>/li>li>60 120 240 360 720br>/li>li>Dbr>/li>li>Wbr>/li>li>Mbr>/li>/ul>p>If code>confirm/code> is true, this will indicate the last ticker price within the specified interval. /p>h3 idpublic-websocket-v2-candlestick-chart-request>request/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Candle/td>/tr>tr>td>» interval/td>td>string/td>td>true/td>td>Interval/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:candle.1.BTCUSDC}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response data/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>candle.1.BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>start/span>span classdl>/span>span classp>:/span>span classmi>1647511440000/span>span classp>,/span> span classdl>/span>span classs2>end/span>span classdl>/span>span classp>:/span>span classmi>1647511499999/span>span classp>,/span> span classdl>/span>span classs2>interval/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>open/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>close/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>high/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>low/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>44111/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>volume/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>turnover/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>confirm/span>span classdl>/span>span classp>:/span>span classkc>true/span>span classp>,/span> span classdl>/span>span classs2>time/span>span classdl>/span>span classp>:/span>span classmi>1647511500752/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1647511500752/span>span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v2-candlestick-chart-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>» type/td>td>string/td>td>Snapshot or delta/td>/tr>tr>td>»» start/td>td>integer/td>td>Start time/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» interval/td>td>string/td>td>Candlestick chart time indicators: Numbers represent minutes, D for Days, M for Month and W for Week — 1 5 15 30 60 120 240 360 720 "D" "M" "W"/td>/tr>tr>td>»» low/td>td>string/td>td>Low price/td>/tr>tr>td>»» high/td>td>string/td>td>High price/td>/tr>tr>td>»» open/td>td>string/td>td>Open price/td>/tr>tr>td>»» close/td>td>string/td>td>Close price/td>/tr>tr>td>»» volume/td>td>string/td>td>Trading volume/td>/tr>tr>td>»» turnover/td>td>string/td>td>Turnover/td>/tr>tr>td>»» confirm/td>td>string/td>td>If it is the last tick of this candle/td>/tr>tr>td>»» time/td>td>string/td>td>Current time/td>/tr>/tbody>/table>h2 idpublic-websocket-v2-all-tickers>All Tickers/h2>p>Get latest information for all symbols./p>p>This topic only utilizes the update field. Both the delete and insert fields are null. If a key is not found in the update field, its value has not changed./p>h3 idpublic-websocket-v2-all-tickers-request>Request/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Limit/th>th>Comment/th>/tr>/thead>tbody>tr>td>» op/td>td>string/td>td>true/td>td>Subscribe/td>/tr>tr>td>» args/td>td>string/td>td>true/td>td>Instrument info/td>/tr>tr>td>» frequency/td>td>string/td>td>true/td>td>H means High frequency, M means middle frequency/td>/tr>tr>td>» symbol/td>td>string/td>td>true/td>td>Symbol/td>/tr>/tbody>/table>blockquote>p>How to Subscribe/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classnx>ws/span>span classp>./span>span classnx>send/span>span classp>(/span>span classdl>/span>span classs1>{op:subscribe,args:instrumentInfo.all}/span>span classdl>/span>span classp>)/span>/code>/pre>/div>blockquote>p>response/p>/blockquote>div classhighlight>pre classhighlight javascript tab-javascript>code>span classp>{/span> span classdl>/span>span classs2>topic/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>instrumentInfo.all/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>data/span>span classdl>/span>span classp>:/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>LINKUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.966/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0510829587249694/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>7.401/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.931/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.966/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>6.965/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>37279.7137/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5128.7/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5647.1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>BTCUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21572.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0194318181818182/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>25306.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>17001.5/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21412.060000000002752512/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>21409.83/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1334891.4545/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>64.858/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>49.598/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ETHUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1680.45/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.0150631538844767/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1805.65/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1680.45/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1654.64/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>1654.1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>664502.346/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>389.16/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>375.87/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>},/span> span classp>{/span> span classdl>/span>span classs2>s/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>DOGEUSDC/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>p/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0621/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>pr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>-0.1013024602026049/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>h/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.1481/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>l/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0501/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.06773/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>xp/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0677/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>to/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>5007.69/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>v/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>70977/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>fr/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0.0000125/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>o/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>43216/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>tc/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>0/span>span classdl>/span> span classp>}/span> span classp>,/span> span classdl>/span>span classs2>type/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>snapshot/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>ts/span>span classdl>/span>span classp>:/span>span classmi>1661500091389816/span>span classp>}/span>/code>/pre>/div>h3 idpublic-websocket-v2-all-tickers-response-data>Response data/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» topic/td>td>string/td>td>Same as request args/td>/tr>tr>td>»» s/td>td>string/td>td>Symbol/td>/tr>tr>td>»» pr/td>td>string/td>td>24H change (%)/td>/tr>tr>td>»» p/td>td>string/td>td>Last price/td>/tr>tr>td>»» h/td>td>string/td>td>24H highest price/td>/tr>tr>td>»» l/td>td>string/td>td>24H lowest price/td>/tr>tr>td>»» op/td>td>string/td>td>Oracle price/td>/tr>tr>td>»» xp/td>td>string/td>td>Index price/td>/tr>tr>td>»» o/td>td>string/td>td>Open interest/td>/tr>tr>td>»» to/td>td>string/td>td>24H turnover/td>/tr>tr>td>»» v/td>td>string/td>td>24H trading volume/td>/tr>tr>td>»» fr/td>td>string/td>td>Funding rate/td>/tr>tr>td>»» tc/td>td>string/td>td>24H trade count/td>/tr>/tbody>/table>h1 idprivate-websocket-v2>Private Websocket V2/h1>h2 idprivate-websocket-v2-send-authority-request>Send Authority Request/h2>ul>li>Use apiKeyCredentials.secret sign, the rule as code/li>li>The topic can be subscribed to during authentication/li>li>Send authority request/li>li>After each successful subscription, the client will receive the snapshot (full data)/li>li>Type : snapshot means full data, delta means incremental data. If it is none, type will default to snapshot./li>/ul>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>const/span> span classnx>apiKeyCredentials/span> span classo>/span> span classp>{/span>span classdl>/span>span classs2>key/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>f6c1e736-fa6b-01df-2822-b9359b3918ae/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>secret/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>sAVchdqy_n9zY7TOIDsqkyg0we3uF0_gGbvyIoob/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>passphrase/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>Ri08mFrOt2Uaiym/span>span classdl>/span>span classp>}/span>span classkd>const/span> span classnx>timestamp/span> span classo>/span> span classmi>1647502440973/span>span classp>;/span>span classkd>const/span> span classnx>request_path/span> span classo>/span> span classdl>/span>span classs1>/ws/accounts/span>span classdl>/span>span classp>;/span>span classkd>const/span> span classnx>http_method/span> span classo>/span> span classdl>/span>span classs1>GET/span>span classdl>/span>span classp>;/span>span classkd>const/span> span classnx>messageString/span>span classp>:/span> span classnx>string/span> span classo>/span> span classp>(/span> span classnx>timestamp/span> span classo>+/span> span classnx>http_method/span> span classo>+/span> span classnx>request_path/span>span classp>);/span>span classkd>const/span> span classnx>key/span> span classo>/span> span classnx>Buffer/span>span classp>./span>span classk>from/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>apiKeyCredentials/span>span classp>./span>span classnx>secret/span>span classp>)./span>span classnx>toString/span>span classp>(/span>span classdl>/span>span classs1>base64/span>span classdl>/span>span classp>);/span>span classkd>const/span> span classnx>hash/span> span classo>/span> span classnx>cryptojs/span>span classp>./span>span classnx>HmacSHA256/span>span classp>(/span>span classnx>messageString/span>span classp>,/span> span classnx>key/span>span classp>);/span>span classkd>const/span> span classnx>signature/span> span classo>/span> span classnx>hash/span>span classp>./span>span classnx>toString/span>span classp>(/span>span classnx>cryptojs/span>span classp>./span>span classnx>enc/span>span classp>./span>span classnx>Base64/span>span classp>);/span>span classc1>//auth sign/span>span classkd>const/span> span classnx>req/span> span classo>/span> span classp>{/span> span classdl>/span>span classs1>type/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs1>login/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>topics/span>span classdl>/span>span classp>:/span> span classp>/span>span classdl>/span>span classs1>ws_notify_v1/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs1>ws_accounts_v2/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>httpMethod/span>span classdl>/span>span classp>:/span>span classnx>http_method/span>span classp>,/span> span classdl>/span>span classs1>requestPath/span>span classdl>/span>span classp>:/span>span classnx>request_path/span>span classp>,/span> span classdl>/span>span classs1>apiKey/span>span classdl>/span>span classp>:/span> span classnx>apiKeyCredentials/span>span classp>/span>span classdl>/span>span classs1>key/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>passphrase/span>span classdl>/span>span classp>:/span> span classnx>apiKeyCredentials/span>span classp>/span>span classdl>/span>span classs1>passphrase/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs1>timestamp/span>span classdl>/span>span classp>:/span> span classnx>timestamp/span>span classp>,/span> span classdl>/span>span classs1>signature/span>span classdl>/span>span classp>:/span> span classnx>signature/span>span classp>,/span>span classp>}/span>span classnx>sendStr/span> span classo>/span> span classp>{/span> span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span> span classdl>/span>span classs2>login/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span> span classp>/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>req/span>span classp>)/span> span classp>}/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>sendStr/span>span classp>));/span>span classc1>//add subscribe/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>({/span>span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>subscribe/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ws_accounts_v1/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>ws_notify_v1/span>span classdl>/span>span classp>}));/span>span classc1>//cancel subscribe/span>span classnx>websocket/span>span classp>./span>span classnx>send/span>span classp>({/span>span classdl>/span>span classs2>op/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>unsubscribe/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>args/span>span classdl>/span>span classp>:/span>span classdl>/span>span classs2>ws_accounts_v1/span>span classdl>/span>span classp>,/span>span classdl>/span>span classs2>ws_notify_v1/span>span classdl>/span>span classp>});/span>/code>/pre>/div>p>Response Errors： /p>ul>li>p>request param errorbr>code>{"success":false,"ret_msg":"msg param error","conn_id":"xxxxxxxxxxsasad"}/code> /p>/li>li>p>user authority errorbr>code>{"success":false,"ret_msg":"login authority err,"conn_id":"xxxxxxxxxxsasad"}/code> /p>/li>/ul>h2 idprivate-websocket-v2-subscription-success-push-data>Subscription Success Push Data/h2>div classhighlight>pre classhighlight json tab-json>code>span classw> /span>span classp>{/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v2/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>snapshot/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1652185029033/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185839042/span>span classp>,/span>span classw> /span>span classnl>creditAsset/span>span classp>:/span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048047104/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>DEPOSIT/span>span classp>,/span>span classw> /span>span classnl>creditAmount/span>span classp>:/span>span classs2>100.000000/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classmi>1652185839042/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classs2>0x7369d3f8d860b10a443c6a6d55c0ea4f2ab106f264a8ad28b822a33cba6aead8/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>SUCCESS_L2_APPROVED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>FILLED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classs2>2500.0000/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>maxSize/span>span classp>:/span>span classs2>2820.000/span>span classp>,/span>span classw> /span>span classnl>sumOpen/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>sumClose/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>netFunding/span>span classp>:/span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652179377769/span>span classp>,/span>span classw> /span>span classnl>realizedPnl/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classs2>438.486000/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classs2>USDC/span>span classw> /span>span classnl>pendingDepositAmount/span>span classp>:/span>span classw> /span>span classs2>5000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferInAmount/span>span classp>:/span>span classw> /span>span classs2>2000/span>span classp>,/span>span classw> /span>span classnl>pendingTransferOutAmount/span>span classp>:/span>span classw> /span>span classs2>3003/span>span classp>,/span>span classw> /span>span classnl>pendingWithdrawAmount/span>span classp>:/span>span classw> /span>span classs2>3233/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652174136588/span>span classp>,/span>span classw> /span>span classnl>positionId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>starkKeyYCoordinate/span>span classp>:/span>span classs2>0x070880c806d8adfc6ea3fafeb9ea269022f8d8aa797849d9f98660006f33e44f/span>span classp>,/span>span classw> /span>span classnl>userId/span>span classp>:/span>span classs2>1144093794426437632/span>span classp>,/span>span classw> /span>span classnl>starkKey/span>span classp>:/span>span classs2>0x0408e25bcadc4a25412258f851d171cb8cb9dfe529f69f2e1b93a9caaf983bc2/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652174136588/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>NORMAL/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>liquidity/span>span classp>:/span>span classs2>TAKER/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521361/span>span classp>,/span>span classw> /span>span classnl>isOpen/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>SUCCESS/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>quoteAmount/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048000182272/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185678345/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>positionClosedTransactions/span>span classerr>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>deleverages/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classerr>account_id/span>span classw> /span>span classerr>/span>span classw> /span>span classs2>1/span>span classerr>;/span>span classw> /span>span classerr>symbol/span>span classw> /span>span classerr>/span>span classw> /span>span classs2>BTC-USDC/span>span classerr>;/span>span classw> /span>span classerr>side/span>span classw> /span>span classerr>/span>span classw> /span>span classs2>LONG/span>span classerr>;/span>span classw> /span>span classerr>profit_rate/span>span classw> /span>span classerr>/span>span classw> /span>span classs2>20/span>span classerr>;/span>span classw> /span>span classerr>light_numbers/span>span classw> /span>span classerr>/span>span classw> /span>span classmi>5/span>span classerr>;/span>span classw> /span>span classerr>created_time/span>span classw> /span>span classerr>/span>span classw> /span>span classmi>1652185678345/span>span classerr>;/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivate-websocket-v2-subscription-success-push-data-response-parameters>Response Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» account/td>td>object/td>td>none/td>/tr>tr>td>»» starkKey/td>td>string/td>td>User starkKey/td>/tr>tr>td>»» starkKeyYCoordinate/td>td>string/td>td>User starkKeyYCoordinate/td>/tr>tr>td>»» positionId/td>td>string/td>td>User accountid/td>/tr>tr>td>»» userId/td>td>string/td>td>User ID/td>/tr>tr>td>»» makerFeeRate/td>td>string/td>td>Maker fee rate/td>/tr>tr>td>»» takerFeeRate/td>td>string/td>td>Taker fee rate/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>Created at/td>/tr>tr>td>»» status/td>td>string/td>td>Account status/td>/tr>tr>td>» wallets/td>td>object/td>td>User wallet/td>/tr>tr>td>»» asset/td>td>string/td>td>Asset/td>/tr>tr>td>»» balance/td>td>string/td>td>Wallet balance/td>/tr>tr>td>»» pendingDepositAmount/td>td>string/td>td>Pending deposit amount/td>/tr>tr>td>»» pendingWithdrawAmount/td>td>string/td>td>Pending withdrawal amount/td>/tr>tr>td>»» pendingTransferOutAmount/td>td>string/td>td>Pending outbound transfer amount/td>/tr>tr>td>»» pendingTransferInAmount/td>td>string/td>td>Pending inbound transfer amount/td>/tr>tr>td>» openPositions/td>td>object/td>td>Open positions/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>Side/td>/tr>tr>td>»» size/td>td>string/td>td>Size/td>/tr>tr>td>»» entryPrice/td>td>string/td>td>Entry price/td>/tr>tr>td>»» fee/td>td>string/td>td>Order fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>Created at/td>/tr>tr>td>»» updatedTime/td>td>integer/td>td>Updated time/td>/tr>tr>td>»» netFunding/td>td>string/td>td>Funding fee/td>/tr>tr>td>»» maxSize/td>td>string/td>td>Max position size/td>/tr>tr>td>»» realizedPnl/td>td>string/td>td>Close profit and loss/td>/tr>tr>td>» fills/td>td>object/td>td>/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>Order side/td>/tr>tr>td>»» size/td>td>string/td>td>Fill size/td>/tr>tr>td>»» price/td>td>string/td>td>Fill price/td>/tr>tr>td>»» fee/td>td>string/td>td>Fill fee/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>Open order fill time/td>/tr>tr>td>»» updatedAt/td>td>integer/td>td>Open order fill update time/td>/tr>tr>td>»» isOpen/td>td>bool/td>td>Is this an open order?/td>/tr>tr>td>»» id/td>td>string/td>td>Fill ID/td>/tr>tr>td>»» orderId/td>td>string/td>td>Order ID/td>/tr>tr>td>»» liquidity/td>td>string/td>td>Taker or Maker/td>/tr>tr>td>»» status/td>td>string/td>td>Fill status/td>/tr>tr>td>» orders/td>td>object/td>td>/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>Order side/td>/tr>tr>td>»» size/td>td>string/td>td>Order size/td>/tr>tr>td>»» price/td>td>string/td>td>Order open price/td>/tr>tr>td>»» type/td>td>string/td>td>Order Type/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>Open order time/td>/tr>tr>td>»» updatedAt/td>td>integer/td>td>Order update time/td>/tr>tr>td>»» isDeleverage/td>td>bool/td>td>Deleverage order?/td>/tr>tr>td>»» isLiquidate/td>td>bool/td>td>Liquidate order?/td>/tr>tr>td>»» reduceOnly/td>td>bool/td>td>Open reduce order only/td>/tr>tr>td>»» unfillableAt/td>td>int/td>td>Order expired time/td>/tr>tr>td>»» id/td>td>string/td>td>ID/td>/tr>tr>td>»» orderId/td>td>string/td>td>Order ID/td>/tr>tr>td>»» liquidity/td>td>string/td>td>Taker or MAKER/td>/tr>tr>td>»» status/td>td>string/td>td>Order status/td>/tr>tr>td>»» cumSuccessFillFee/td>td>string/td>td>Cumulative success fill fee/td>/tr>tr>td>»» trailingPercent/td>td>string/td>td>Trailing-stop/td>/tr>tr>td>»» cumSuccessFillValue/td>td>string/td>td>Cumulative success fill value/td>/tr>tr>td>»» cancelReason/td>td>string/td>td>Reason for cancelation/td>/tr>tr>td>»» timeInForce/td>td>string/td>td>Open order timeInForce/td>/tr>tr>td>»» limitFee/td>td>string/td>td>Open order max. fee/td>/tr>tr>td>»» clientOrderId/td>td>string/td>td>Client to create randomized ID/td>/tr>tr>td>»» triggerPrice/td>td>string/td>td>Trigger Price/td>/tr>tr>td>»» cumSuccessFillSize/td>td>string/td>td>Cumulative Success Fill Size/td>/tr>tr>td>» transfers/td>td>object/td>td>Withdraw and deposit/td>/tr>tr>td>»» createdAt/td>td>integer/td>td>Created time/td>/tr>tr>td>»» confirmedAt/td>td>integer/td>td>Confirm time/td>/tr>tr>td>»» creditAsset/td>td>string/td>td>Asset/td>/tr>tr>td>»» type/td>td>bool/td>td>Transfer type/td>/tr>tr>td>»» id/td>td>string/td>td>Transfer ID/td>/tr>tr>td>»» creditAmount/td>td>string/td>td>Transfer amount/td>/tr>tr>td>»» transactionHash/td>td>string/td>td>Tx hash/td>/tr>tr>td>»» status/td>td>string/td>td>Status/td>/tr>tr>td>» deleverages/td>td>object / deleverages/td>td>/td>/tr>tr>td>»» symbol/td>td>string/td>td>Symbol/td>/tr>tr>td>»» side/td>td>string/td>td>Postion side/td>/tr>tr>td>»» profit_rate/td>td>string/td>td>Postion profit rate/td>/tr>tr>td>»» light_numbers/td>td>string/td>td>ADL ranking/td>/tr>tr>td>»» created_time/td>td>int/td>td>Created time/td>/tr>/tbody>/table>h2 idprivate-websocket-v2-order-submission-push>Order Submission Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>PENDING/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-post-submission-of-maker-order-push>Post-Submission of Maker Order Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>OPEN/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-post-cancel-order-push>Post-Cancel Order Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>CANCELED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-successful-order-execution-push>Successful Order Execution Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classw>/span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>orderId/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>fee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>liquidity/span>span classp>:/span>span classs2>TAKER/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521361/span>span classp>,/span>span classw> /span>span classnl>isOpen/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>quoteAmount/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048000182272/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185678345/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>exitPrice/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>LONG/span>span classp>,/span>span classw> /span>span classnl>maxSize/span>span classp>:/span>span classs2>2820.000/span>span classp>,/span>span classw> /span>span classnl>sumOpen/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>sumClose/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>netFunding/span>span classp>:/span>span classs2>0.000000/span>span classp>,/span>span classw> /span>span classnl>entryPrice/span>span classp>:/span>span classs2>2500.000000000000000000/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652179377769/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>1.820/span>span classp>,/span>span classw> /span>span classnl>realizedPnl/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>closedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>symbol/span>span classp>:/span>span classs2>ETH-USDC/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>trailingPercent/span>span classp>:/span>span classs2>0/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>LIMIT/span>span classp>,/span>span classw> /span>span classnl>unfillableAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>isDeleverage/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1652185521339/span>span classp>,/span>span classw> /span>span classnl>price/span>span classp>:/span>span classs2>2500.0/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillValue/span>span classp>:/span>span classs2>1250.0000/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>2048046080/span>span classp>,/span>span classw> /span>span classnl>cancelReason/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>timeInForce/span>span classp>:/span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>updatedAt/span>span classp>:/span>span classmi>1652185521392/span>span classp>,/span>span classw> /span>span classnl>limitFee/span>span classp>:/span>span classs2>0.625000/span>span classp>,/span>span classw> /span>span classnl>side/span>span classp>:/span>span classs2>BUY/span>span classp>,/span>span classw> /span>span classnl>clientOrderId/span>span classp>:/span>span classs2>522843990/span>span classp>,/span>span classw> /span>span classnl>triggerPrice/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1654779600000/span>span classp>,/span>span classw> /span>span classnl>cumSuccessFillSize/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>accountId/span>span classp>:/span>span classs2>1024000/span>span classp>,/span>span classw> /span>span classnl>size/span>span classp>:/span>span classs2>0.500/span>span classp>,/span>span classw> /span>span classnl>reduceOnly/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>isLiquidate/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>remainingSize/span>span classp>:/span>span classs2>0.000/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>FILLED/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-deposit-success-push>Deposit Success Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>wallets/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>balance/span>span classp>:/span>span classs2>438.486000/span>span classp>,/span>span classw> /span>span classnl>asset/span>span classp>:/span>span classs2>USDC/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-withdrawal-request-submission-push>Withdrawal Request Submission Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classw>/span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>delta/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classs2>ws_accounts_v1/span>span classp>,/span>span classw> /span>span classnl>contents/span>span classp>:{/span>span classw> /span>span classnl>fills/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>positions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>accounts/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>transfers/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classs2>QUEUED/span>span classp>,/span>span classw> /span>span classnl>transactionId/span>span classp>:/span>span classs2>39190120/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classs2>89abf9d72432/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classs2>WITHDRAWAL/span>span classp>,/span>span classw> /span>span classnl>creditAsset/span>span classp>:/span>span classs2>USDC/span>span classp>,/span>span classw> /span>span classnl>creditAmount/span>span classp>:/span>span classs2>100/span>span classp>,/span>span classw> /span>span classnl>transactionHash/span>span classp>:/span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>confirmedAt/span>span classp>:/span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>createdAt/span>span classp>:/span>span classmi>1647502440973/span>span classp>,/span>span classw> /span>span classnl>expiresAt/span>span classp>:/span>span classmi>1647502440973/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idprivate-websocket-v2-notify-message-push>Notify Message Push/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>contents/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>unreadNum/span>span classp>:/span>span classw> /span>span classmi>24/span>span classp>,/span>span classw> /span>span classnl>notifyMsgList/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1145486332832022528/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>lang/span>span classp>:/span>span classw> /span>span classs2>en/span>span classp>,/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classs2>Deposit success /span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classs2>Your deposit of 100.000000 USDC has been confirmed./span>span classp>,/span>span classw> /span>span classnl>androidLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iosLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>webLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>read/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>1682357834534/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classw> /span>span classs2>ws_notify_v1/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>snapshot/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idprivate-websocket-v2-notify-message-push-response-parameters>Response Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Comment/th>/tr>/thead>tbody>tr>td>» notifyMsgList/td>td>object/td>td>Notification message list/td>/tr>tr>td>»» id/td>td>string/td>td>Notification ID/td>/tr>tr>td>»» category/td>td>int/td>td>Notification category/td>/tr>tr>td>»» lang/td>td>string/td>td>Language/td>/tr>tr>td>»» title/td>td>string/td>td>Title/td>/tr>tr>td>»» content/td>td>string/td>td>Content/td>/tr>tr>td>»» androidLink/td>td>string/td>td>Android link/td>/tr>tr>td>»» iosLink/td>td>string/td>td>Ios link/td>/tr>tr>td>»» webLink/td>td>string/td>td>Web link/td>/tr>tr>td>»» read/td>td>bool/td>td>If notification has been read/td>/tr>tr>td>»» createdTime/td>td>int/td>td>Created time/td>/tr>/tbody>/table>h2 idprivate-websocket-v2-new-notification-message-push>New Notification Message Push/h2>blockquote>p>Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>contents/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>notify_list/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1145486332832022528/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>NOTIFY_CATEGORY_ACCOUNT/span>span classp>,/span>span classw> /span>span classnl>lang/span>span classp>:/span>span classw> /span>span classs2>en/span>span classp>,/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classs2>Deposit success /span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classs2>Your deposit of 100.000000 USDC has been confirmed./span>span classp>,/span>span classw> /span>span classnl>androidLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>iosLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>webLink/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>read/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>createdTime/span>span classp>:/span>span classw> /span>span classmi>1682357834534/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>topic/span>span classp>:/span>span classw> /span>span classs2>ws_notify_v1/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>delta/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 idgnosis-multi-sig-wallet-endpoint-for-market-makers>Gnosis Multi-Sig Wallet Endpoint for Market Makers/h1>p>v1.0.0/p>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-creating-a-gnosis-safe-multi-sig-wallet>Creating a Gnosis Safe Multi-Sig Wallet/h2>p>Click on code>https://gnosis-safe.io/app//code> to access the application on desktop. Refer to the document a hrefhttps://static-pro.apex.exchange/file/Gnosis-Step-by-Step-Guide-en.pdf>gnosis_safe/a> and create your multi-sig wallet according to the following steps: /p>ul>li>Select the Ethereum network/li>li>You will need to connect an existing wallet to Gnosis Safe to create an account and ensure that you have some ETH in the wallet to pay for transaction fees that may be incurred during the setup/li>li>Enter the wallet name and include the names, addresses and number of stakeholders involved in the authentication of withdrawals from this multi-sig wallet. Once you're certain that all information entered is accurate, you can proceed with the creation of the Gnosis Safe wallet/li>li>Transfer funds into the Gnosis Safe wallet/li>/ul>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-starkware-smart-contract-abi-code>StarkWare Smart Contract ABI Code/h2>div classhighlight>pre classhighlight json tab-json>code>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>assetType/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>vaultId/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>quantizedAmount/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>depositERC20/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>nonpayable/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>getEthKey/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>address/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>address/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>view/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>assetId/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>getWithdrawalBalance/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>balance/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>view/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>address/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>ethKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>address/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>bytes/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkSignature/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>bytes/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>registerEthAddress/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>nonpayable/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>starkKey/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>assetId/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>withdraw/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>nonpayable/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw> /span>span classp>}/span>span classw>/span>span classp>/span>span classw>/span>/code>/pre>/div>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-generating-apexpro-l2key-account>Generating ApexPro L2key Account/h2>ul>li>Use Apex Pro's python SDK: Authorize your Ethereum private keys to create corresponding public and private Stark Keys — refer to python codes/li>/ul>blockquote>p>Generating starkKey/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classerr>from/span>span classw> /span>span classerr>apexpro.http_private/span>span classw> /span>span classerr>import/span>span classw> /span>span classerr>HttpPrivate/span>span classw>/span>span classerr>from/span>span classw> /span>span classerr>apexpro.constants/span>span classw> /span>span classerr>import/span>span classw> /span>span classerr>APEX_HTTP_TEST,/span>span classw> /span>span classerr>NETWORKID_TEST,/span>span classw> /span>span classerr>APEX_HTTP_MAIN,/span>span classw> /span>span classerr>NETWORKID_MAIN/span>span classw>/span>span classerr>priKey/span>span classw> /span>span classerr>/span>span classw> /span>span classs2>your eth private key/span>span classw>/span>span classerr>client/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>HttpPrivate(APEX_HTTP_MAIN,/span>span classw> /span>span classerr>network_idNETWORKID_MAIN,/span>span classw> /span>span classerr>eth_private_keypriKey)/span>span classw>/span>span classerr>configs/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>client.configs()/span>span classw>/span>span classerr>stark_key_pair_with_y_coordinate/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>client.derive_stark_key(client.default_address)/span>span classw>/span>/code>/pre>/div>ul>li>- Use Apex Pro's python SDK: Proceed with the register_user method and enter the gnosis-safe multi-sig wallet address in eth_mul_address to generate the account ID — Refer to python codes /li>/ul>blockquote>p>register_user method to generate account ID/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classerr>nonceRes/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>client.generate_nonce(starkKeystark_key_pair_with_y_coordinate/span>span classp>/span>span classerr>public_key/span>span classp>/span>span classerr>,ethAddressclient.default_address,chainIdNETWORKID_MAIN)/span>span classw>/span>span classerr>regRes/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>client.register_user(noncenonceRes/span>span classp>/span>span classerr>data/span>span classp>/span>span classerr>nonce/span>span classp>/span>span classerr>,starkKeystark_key_pair_with_y_coordinate/span>span classp>/span>span classerr>public_key/span>span classp>/span>span classerr>,stark_public_key_y_coordinatestark_key_pair_with_y_coordinate/span>span classp>/span>span classerr>public_key_y_coordinate/span>span classp>/span>span classerr>,ethereum_addressclient.default_address,/span>span classw> /span>span classerr>eth_mul_address/span>span classs2>your mul eth address/span>span classerr>)/span>span classw>/span>span classerr>print(regRes/span>span classp>/span>span classerr>data/span>span classp>/span>span classerr>account/span>span classp>/span>span classerr>positionId/span>span classp>/span>span classerr>)/span>span classw> /span>span classerr>#account/span>span classw> /span>span classerr>ID/span>span classw> /span>/code>/pre>/div>ul>li>Trigger the StarkWare contract interaction via the gnosis-safe multi-sig wallet by using the registerEthAddress method under StarkWare's contract, then linking the user's L2 data with the Gnosis Safe walletul>li>starkware Contract Address: code>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/code>/li>li>ethKey: Corresponding Gnosis Safe multi-sig wallet address/li>li>starkKey: L2 account stark_key_pair public_keycode>stark_key_pair_with_y_coordinate'public_key'/code>/li>li>starkSignature: Authentication signature needs to be generated, refer to python codes /li>/ul>/li>/ul>blockquote>p>Generating Stark Signature/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classerr>from/span>span classw> /span>span classerr>apexpro.helpers.request_helpers/span>span classw> /span>span classerr>import/span>span classw> /span>span classerr>calc_bind_owner_key_sig_hash,/span>span classw> /span>span classerr>starkex_sign,/span>span classw> /span>span classerr>starkex_verify/span>span classw>/span>span classerr>hash/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>calc_bind_owner_key_sig_hash(/span>span classs2>your stark_key_pair pubic key/span>span classerr>,/span>span classw> /span>span classs2>your eth address/span>span classerr>)/span>span classw>/span>span classerr>print(hash.hex())/span>span classw>/span>span classerr>signature/span>span classw> /span>span classerr>/span>span classw> /span>span classerr>starkex_sign(hash,/span>span classw> /span>span classs2>your stark_key_pair private key/span>span classerr>)/span>span classw>/span>span classerr>print(/span>span classs2>signature:/span>span classw> /span>span classerr>+/span>span classw> /span>span classerr>signature)/span>span classw>/span>/code>/pre>/div>ul>li>- After the Gnosis Safe wallet is linked, all transactions (L2) will require authentication by the Gnosis Safe multi-sig wallet/li>/ul>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-authorize-starkware-contract-to-transfer-usdc-via-gnosis-safe>Authorize StarkWare Contract to Transfer USDC via Gnosis Safe/h2>p>As deposits will be processed through StarkWare, you will need to authorize the StarkWare contract to transfer your USDC assets./p>ul>li>Proceed with a new transaction via Gnosis Safe/li>li>Enter transaction details:ul>li>Enter the USDC contract address: code>0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/code>/li>li>Enter the USDC contract ABI and select the approve method/li>/ul>/li>/ul>blockquote>p>USDC Contract ABI/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>inputs/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>/span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>address/span>span classp>,/span>span classw>/span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>spender/span>span classp>,/span>span classw>/span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>address/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw>/span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>value/span>span classp>,/span>span classw>/span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>uint256/span>span classw>/span>span classp>},/span>span classw>/span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>approve/span>span classp>,/span>span classw> /span>span classnl>outputs/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>/span>span classnl>internalType/span>span classp>:/span>span classw> /span>span classs2>bool/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>bool/span>span classw>/span>span classp>},/span>span classw>/span>span classnl>stateMutability/span>span classp>:/span>span classw> /span>span classs2>nonpayable/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>function/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>ul>li>Spender address (Enter StarkWare's contract address): code>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/code>/li>li>value: For accuracy, we recommend that you enter the correct deposit amount (to 6 decimal places), e.g. 100 USDC should be entered as 100000000/li>/ul>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-deposit-via-gnosis-safe>Deposit via Gnosis Safe/h2>ul>li>Trigger a new transaction on Gnosis Safe/li>li>Enter transaction details:ul>li>StarkWare Contract Address: code>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/code>/li>li>StarkWare Contract ABI: Refer to a href/#gnosis-multi-sig-wallet-endpoint-for-market-makers-creating-a-gnosis-safe-multi-sig-wallet>the complete StarkWare contract ABI code /a>/li>li>Select code>depositErc20/code> method and enter the corresponding amount/li>li>starkKey: L2 account stark_key_pair public_keycode>stark_key_pair_with_y_coordinate'public_key'/code>/li>li>assetType: Corresponding asset type code>0x02893294412a4c8f915f75892b395ebbf6859ec246ec365c3b1f56f47c3a0a5d/code>/li>li>valutId: L2 account to asset pool, account_id: code>351667704786059600/code>/li>li>quantizeAmount: USDC deposit amount, to 6 decimal places e.g. 100 USDC should be entered as 100000000/li>/ul>/li>li>After reviewing the parameters and ensuring that they are correct, confirm the deposit transaction/li>li>For other stakeholders involved in the Gnosis Safe wallet, use your personal wallet to authorize the transaction and complete the deposit process/li>/ul>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-checking-for-withdrawable-balance-with-gnosis-safe>Checking for Withdrawable Balance With Gnosis Safe/h2>ul>li>Trigger a new transaction on Gnosis Safe/li>li>Enter transaction details:ul>li>StarkWare Contract Address: code>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/code>/li>li>StarkWare Contract ABI: Refer to a href/#gnosis-multi-sig-wallet-endpoint-for-market-makers-creating-a-gnosis-safe-multi-sig-wallet>the complete StarkWare contract ABI code /a>/li>li>Select the code>getWithdrawalBalance/code> method and enter the corresponding parameters; you can check the available withdrawable balance (you will need to remove 6 zeros from the amount)/li>li>starkKey: Enter the gnosis-safe multi-sig wallet address, please ensure that this is not the L2 account stark_key_pair public_key/li>li>assetType: Corresponding asset type code>0x02893294412a4c8f915f75892b395ebbf6859ec246ec365c3b1f56f47c3a0a5d/code>/li>/ul>/li>/ul>h2 idgnosis-multi-sig-wallet-endpoint-for-market-makers-initiating-withdrawals-with-gnosis-safe>Initiating Withdrawals With Gnosis Safe/h2>ul>li>Trigger a new transaction on Gnosis Safe/li>li>Enter transaction details:ul>li>Starkware Contract Address: code>0xA1D5443F2FB80A5A55ac804C948B45ce4C52DCbb/code>/li>li>StarkWare Contract ABI: Refer to a href/#gnosis-multi-sig-wallet-endpoint-for-market-makers-creating-a-gnosis-safe-multi-sig-wallet>the complete StarkWare contract ABI code /a>/li>li>Select the code>withdraw/code> method and fill up the corresponding parameters; this will withdraw all of your assets from L2 into your gnosis-safe wallet/li>li>starkKey: Enter the gnosis-safe multi-sig wallet address, please ensure that this is not the L2 account stark_key_pair public_key/li>li>assetType: Corresponding asset type code>0x02893294412a4c8f915f75892b395ebbf6859ec246ec365c3b1f56f47c3a0a5d/code>/li>/ul>/li>/ul>h1 idq-amp-a>Q & A/h1>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-1-q-what-is-the-easiest-way-to-get-started-with-the-api-sdk>1. Q: What is the easiest way to get started with the API SDK?/h3>p>A: Refer to a hrefhttps://github.com/ApeX-Protocol/apexpro-openapi/blob/main/README.md>Python sdk readme/a>. It's the quickest way to learn how to install and use the Python SDK, including instructions on registering, creating orders, retrieving quote data, making withdrawals, and more. /p>p>Open-API SDKbr>- a hrefhttps://github.com/ApeX-Protocol/apexpro-openapi>OpenApi-Python-SDK/a> - Official OpenApi Python SDKbr>- a hrefhttps://github.com/ApeX-Protocol/apexpro-connector-java>OpenApi-Java-SDK/a> - Official OpenApi JAVA SDKbr>- a hrefhttps://github.com/ApeX-Protocol/apexpro-connector-node>OpenApi-Node.JS-SDK/a> - Official OpenApi Node JS SDK /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-2-q-what-is-an-apikey-what-is-a-starkkey>2. Q: What is an APIKey? What is a StarkKey?/h3>p>A: Generally, CEX APIs have only one APIKey. However, ApeX introduces StarkKey. Both the order creation API and withdrawal API require the use of StarkKey signatures. Stark signatures are verified on the L1 chain to ensure the security of users' assets./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-3-q-what-is-a-limit-fee-what-is-a-limit-fee-rate>3. Q: What is a Limit Fee? What is a Limit Fee Rate?/h3>p>A: Limit Fee is the maximum fee that users can accept. This field is not present in CEX. However, in order to prevent the platform from manipulating handling fees, DEX allows users to set this value and sign it for verification. In the Python SDK's create-order API, users can use the taker fee rate to set the LimitFeeRate parameter, and the SDK will assist in calculating the Limit Fee./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-4-q-what-is-the-expiration-time>4. Q: What is the expiration time?/h3>p>A: An expiration time is set when creating an order and withdrawal. It determines the validity period for both actions. The recommended expiration time is 28 days. For L2 signatures, the expiration time is calculated in hours, while for the API, it is measured in seconds.br> L2 expiration: (current timestamp in milliseconds + 28 days) / (3,600 * 1,000)br> API expiration: L2 expiration * 3,600 * 1,000 /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-5-q-what-is-a-clientid>5. Q: What is a clientId?/h3>p>A: When creating an order or withdrawing funds, the client needs to generate a clientId. This clientId enables the user to record the ID and conduct local idempotent processing. Additionally, when signing L2, the clientId is used to convert it into the nonce field of the signature for verification. Please refer to the algorithm for further details: https://api-docs.pro.apex.exchange/#general-client_id-and-nonce-generation /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-6-q-is-the-starkkey-generated-consistently-every-time>6. Q: Is the StarkKey generated consistently every time?/h3>p>A: Yes, the StarkKey generated in the web, app, or SDK is consistent because they all utilize the same signature format. However, if the user manually modifies the signature format, it may result in a different StarkKey. It's important to note that each StarkKey corresponds to a unique account ID in the system./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-7-q-is-apikey-generated-consistently-every-time>7. Q: Is Apikey generated consistently every time?/h3>p>A: No, the generated APIKey is not consistent every time. Before calling the onboarding interface to generate an APIKey, the generate-nonce interface must be called to create a nonce for use in the onboarding request. Since each nonce value is unique, the resulting APIKey returned by the server is also unique. However, each APIKey corresponds to the same account ID. It's important to note that the APIKey generated and returned by the server is valid each time, provided that the web, app, and SDK are online simultaneously./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-8-q-are-there-any-rate-limits-on-request-frequency>8. Q: Are there any rate limits on request frequency?/h3>p>A: Yes, there are rate limits on request frequency. The frequency request limit mechanism for ordinary API users is detailed in the reference document at https://api-docs.pro.apex.exchange/#general-rate-limits. Market makers have the option to apply to customer service to be added to the IP whitelist and API interface whitelist, which allows them to increase their request limit./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-9-q-why-do-i-have-to-fill-in-the-price-when-creating-a-market-order>9. Q: Why do I have to fill in the price when creating a market order?/h3>p>A: Unlike CEX, which doesn't mandate users to input the price for market orders, ApeX requires users to specify the order price due to the Starkware signature mechanism. Users can calculate the order price manually using the order quantity and market depth, or they can utilize the get_worst_price interface to obtain the order price calculated by the backend. It's important for the market order price to be worse than the index price; otherwise, the order will be canceled./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-10-q-how-to-calculate-user-39-s-total-assets-available-balance-maintenance-margin-etc>10. Q: How to calculate user's total assets, available balance, maintenance margin, etc？/h3>p>A: Please refer to the SDK documentation: https://github.com/ApeX-Protocol/apexpro-openapi/blob/main/tests/account_value.pybr> Total user assets (totalAccountValue)br> Available balance (availableValue)br> Maintenance margin (totalMaintenanceMarginRequirement) /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-11-q-in-which-region-is-the-server-located-in-aws>11. Q: In which region is the server located in AWS?/h3>p>A: "RegionName": "ap-southeast-1",br> "ZoneName": "ap-southeast-1a",br> "ZoneId": "apse1-az1",br> "GroupName": "ap-southeast-1",br> "NetworkBorderGroup": "ap-southeast-1",br> "ZoneType": "availability-zone" /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-12-q-how-do-i-set-limitfee-when-creating-orders-using-the-python-sdk>12. Q: How do I set LimitFee when creating orders using the Python SDK?/h3>p>A: When creating an order using either client.create_order or client.create_order_v2, you can refer to the demo and utilize the LimitFeeRate field. Set the value to the user's takerFeeRate (note that the fee rate cannot exceed 6 decimal places). The SDK will assist in calculating the LimitFee to prevent errors in the user's calculations. It's important to note that the fee calculated by the SDK is not the actual fee charged to the user. Instead, it ensures that when pushed to L1 for verification, the fee charged by the backend cannot exceed the fee provided by the user. This mechanism prevents backend cheating and safeguards the user's assets. /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-13-q-how-many-apikeys-can-be-created-at-most-for-one-account>13. Q: How many APIKeys can be created at most for one account?/h3>p>A: A maximum of 30 APIKeys can be created for one account./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-14-q-when-creating-an-order-using-the-python-sdk-what-happens-if-you-fill-in-numbers-directly>14. Q: When creating an order using the Python SDK, what happens if you fill in numbers directly?/h3>p>A: All numerical values in the order for the Python SDK API client.create_order or client.create_order_v2 must be in string format. This ensures avoidance of numeric precision and length issues, which could lead to calculation errors./p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-15-q-which-python-version-does-the-python-sdk-use>15. Q: Which Python version does the Python SDK use?/h3>p>A: Python 3.6-3.9/p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-16-q-can-i-use-a-usdt-account-directly-if-i-have-used-a-usdc-account-before>16. Q: Can I use a USDT account directly if I have used a USDC account before?/h3>p>A: You need to register again using the v2 interface, client.register_user_v2, and specify the token parameter as token"USDT" /p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-17-q-can-token-deposits-and-withdrawals-be-performed-through-the-api>17. Q: Can token deposits and withdrawals be performed through the API?/h3>p>A: Yes, withdrawals can be initiated through the API, including fast withdrawals and cross-chain withdrawals, but only on the ETH chain. These actions require the use of the user's starkkey pair. Withdrawals are limited to addresses registered by the user. For more information, refer to the following resources:- https://github.com/ApeX-Protocol/apexpro-openapi/blob/main/tests/demo_deposit.py- https://github.com/ApeX-Protocol/apexpro-openapi/blob/main/tests/demo_stark_key_sign.py/p>h3 idq-amp-a-initiating-withdrawals-with-gnosis-safe-18-q-is-it-necessary-to-obtain-configuration-information>18. Q: Is it necessary to obtain configuration information?/h3>p>A: Yes, when using the Python SDK, you must call the client.configs_v2() interface after initializing the client to obtain relevant configuration information./p>h1 iderrors>Errors/h1>p>The API uses the following error codes:/p>table>thead>tr>th>Error Code/th>th>Meaning/th>/tr>/thead>tbody>tr>td>400/td>td>Bad Request : Your request is invalid./td>/tr>tr>td>403/td>td>IP banned : Your IP is banned./td>/tr>tr>td>404/td>td>Not Found : The request path could not be found./td>/tr>tr>td>500/td>td>Internal Server Error: We're experiencing issues with our server. Please try again later./td>/tr>tr>td>503/td>td>Service Unavailable: We're temporarily offline for maintenance. Please try again later./td>/tr>tr>td>10001/td>td>Failed : error request./td>/tr>tr>td>10002/td>td>Requires Login : Your API key is wrong./td>/tr>tr>td>10003/td>td>Too Many Requests : Slow down!/td>/tr>tr>td>10004/td>td>Request Timeout/td>/tr>/tbody>/table>table>thead>tr>th>Error Key/th>th>Meaning/th>/tr>/thead>tbody>tr>td>UNKNOWN/td>td>("Service Error ."),/td>/tr>tr>td>INVALID_L2_SIGNATURE/td>td>("Invalid L2 signature."),/td>/tr>tr>td>INVALID_ETH_ADDRESS/td>td>("Invalid ethAddress."),/td>/tr>tr>td>INVALID_LP_ACCOUNT/td>td>("Invalid lp account id. {accountId}"),/td>/tr>tr>td>INVALID_FEE/td>td>("Invalid fee request {fee}"),/td>/tr>tr>td>INVALID_L2_TX/td>td>("Invalid l2 txhash"),/td>/tr>tr>td>INVALID_USER_ID/td>td>("Invalid userId. {userId}"),/td>/tr>tr>td>INVALID_ACCOUNT_ID/td>td>("Invalid accountId. {accountId}"),/td>/tr>tr>td>INVALID_CURRENCY_ID/td>td>("invalid currencyId. {currencyId} "),/td>/tr>tr>td>INVALID_CLIENT_WITHDRAW_ID/td>td>("Invalid clientWithdraw Id. {clientWithdrawId}"),/td>/tr>tr>td>INVALID_CLIENT_TRANSFER_ID/td>td>("Invalid clientTransfer Id. {clientTransferId}"),/td>/tr>tr>td>INVALID_PAGE_SIZE/td>td>("Invalid page size. {size}"),/td>/tr>tr>td>EMPTY_CHAIN_ID/td>td>("Empty chainId."),/td>/tr>tr>td>EMPTY_CLIENT_FAST_WITHDRAW_ID/td>td>("Empty clientFastWithdraw Id."),/td>/tr>tr>td>EMPTY_PARAM/td>td>("{name}Empty request param."),/td>/tr>tr>td>EMPTY_CLIENT_WITHDRAW_ID/td>td>("Empty clientWithdraw Id."),/td>/tr>tr>td>EMPTY_CLIENT_TRANSFER_ID/td>td>("Empty clientTransfer Id."),/td>/tr>tr>td>AMOUNT_MUST_GREETER_ZERO/td>td>("Amount must greater than 0. {amount}"),/td>/tr>tr>td>ACCOUNT_NOT_FOUND/td>td>("The account does not exist. {accountId}"),/td>/tr>tr>td>ACCOUNT_NOT_FOUND_L2KEY/td>td>("The account does not exist. {l2Key}"),/td>/tr>tr>td>ACCOUNT_NOT_FOUND_LP/td>td>("The account does not exist. {lpAccountId}"),/td>/tr>tr>td>ACCOUNT_CONFLICT_L2KEY/td>td>("The account already exists. Please select another account. {l2Key}"),/td>/tr>tr>td>ORDER_NOT_FOUND/td>td>("This order does not exist. {orderId}"),/td>/tr>tr>td>ORDER_NOT_CANCEL_MATCHED/td>td>("Order processing, please do not cancel. {orderId}"),/td>/tr>tr>td>ORDER_NOT_CANCEL_FILLED/td>td>("Order successful, please do not cancel. {orderId}"),/td>/tr>tr>td>ORDER_NOT_CANCEL_INVALID_STATUS/td>td>("Invalid order, please do not cancel. {orderId}"),/td>/tr>tr>td>ORDER_INVALID_ORDER_TYPE/td>td>("This order type is invalid. {orderType}"),/td>/tr>tr>td>ORDER_INVALID_TIME_IN_FORCE/td>td>("Invalid time-in-force. {timeInForce}"),/td>/tr>tr>td>ORDER_INVALID_STATUS/td>td>("This order status is invalid. {orderStatus}"),/td>/tr>tr>td>ORDER_INVALID_ORDER_SIDE/td>td>("This order direction is invalid. {orderSide}"),/td>/tr>tr>td>ORDER_LIMIT_FEE_NOT_ENOUGH/td>td>("Insufficient gas fees on this order. {limitFee}"),/td>/tr>tr>td>ORDER_FILL_TRANSACTION_ID_NOT_FOUND/td>td>("This order does not exist.{transactionId}"),/td>/tr>tr>td>ORDER_FILL_TRANSACTION_CENSOR_ROUND_CONFLICT/td>td>("Order submission error. {censorRound}"),/td>/tr>tr>td>ORDER_FILL_TRANSACTION_INVALID_STATUS/td>td>("Order submission status is invalid. {transactionStatus}"),/td>/tr>tr>td>ORDER_EMPTY_CLIENT_ORDER_ID/td>td>("Empty clientOrderId."),/td>/tr>tr>td>ORDER_INVALID_CLIENT_ORDER_ID/td>td>("Invalid clientOrderId. {clientOrderId}"),/td>/tr>tr>td>ORDER_LIQUIDATE_ORDER_FAILED/td>td>("Liquidation Unsuccessful."),/td>/tr>tr>td>ORDER_DELEVERAGE_WITH_SAME_ACCOUNT/td>td>("The deleveraging account and the liquidation account are the same, transaction has failed."),/td>/tr>tr>td>ORDER_CLIENT_ORDER_DATA_CONFLICT/td>td>("Please resubmit your order. {clientOrderId}"),/td>/tr>tr>td>ORDER_PRICE_MUST_GREETER_ZERO/td>td>("Price must greater than 0. {price}"),/td>/tr>tr>td>ORDER_SIZE_MUST_GREETER_ZERO/td>td>("Size must greater than 0. {size}"),/td>/tr>tr>td>ORDER_VALUE_MUST_GREETER_ZERO/td>td>("Value must greater than 0. {value}"),/td>/tr>tr>td>ORDER_LIMIT_FEE_MUST_GREETER_ZERO/td>td>("LimitFee must greater than or equal 0. {limitFee}"),/td>/tr>tr>td>ORDER_TRIGGER_PRICE_MUST_GREETER_ZERO/td>td>("TriggerPrice must greater than 0. {triggerPrice}"),/td>/tr>tr>td>ORDER_SYMBOL_DISABLE_TRADE/td>td>("Symbol {symbol} disable trade"),/td>/tr>tr>td>ORDER_SIZE_SMALLER_THAN_SYMBOL_MIN_ORDER_SIZE/td>td>("Order size {size} smaller than symbol {symbol} min order size {minOrderSize}"),/td>/tr>tr>td>ORDER_SIZE_GREATER_THAN_SYMBOL_MAX_ORDER_SIZE/td>td>("Order size {size} greater than symbol {symbol} max order size {maxOrderSize}"),/td>/tr>tr>td>ORDER_LIQUIDATING_ACCOUNT_CANNOT_CREATE_ORDER/td>td>("Account is liquidating, cannot create order"),/td>/tr>tr>td>ORDER_OPEN_ORDER_COUNT_LIMIT_EXCEED/td>td>("You have {openOrderCount} open orders, cannot create new order"),/td>/tr>tr>td>ORDER_WITH_THIS_PRICE_CANNOT_REDUCE_POSITION_ONLY/td>td>("Order with this price {price} cannot reduce position only"),/td>/tr>tr>td>ORDER_SYMBOL_DISABLE_OPEN_POSITION/td>td>("Symbol '{symbol}' disable open position"),/td>/tr>tr>td>ORDER_IS_REDUCE_ONLY_CANNOT_OPEN_POSITION/td>td>("Order is reduce-only, cannot open position"),/td>/tr>tr>td>ORDER_IS_LIQUIDATE_ONLY_CANNOT_OPEN_POSITION/td>td>("Order liquidated, cannot open position"),/td>/tr>tr>td>ORDER_IS_DELEVERAGE_ONLY_CANNOT_OPEN_POSITION/td>td>("Order auto deleveraged, cannot open position"),/td>/tr>tr>td>ORDER_POSSIBLE_GREATER_THAN_SYMBOL_MAX_POSITION/td>td>("If order is filled, it can be greater than symbol '{symbol}' max. position size {maxPositionSize}"),/td>/tr>tr>td>ORDER_IS_LIQUIDATE_NOT_MATCH_PRE_CONDITION/td>td>("Liquidation order not match pre-condition: beforeTV({beforeTV}) < beforeTR({beforeTR})"),/td>/tr>tr>td>ORDER_IS_LIQUIDATE_AND_DELEVERAGE_NOT_MATCH_PRE_CONDITION/td>td>("Liquidation and ADL order not match pre-condition:beforeTV({beforeTV}) < 0"),/td>/tr>tr>td>ORDER_POSSIBLE_LEAD_TO_ACCOUNT_LIQUIDATED/td>td>("If order is filled, your account may be liquidated."),/td>/tr>tr>td>ORDER_POSSIBLE_LEAD_TO_ACCOUNT_LIQUIDATED_TV_TR_RATE_NOT_IMPROVED/td>td>("If order is filled and TV/TR does not improve, your account may be liquidated."),/td>/tr>tr>td>ORDER_THERE_IS_NOT_ENOUGH_MARGIN_TO_OPEN_POSITION/td>td>("If order is filled, there is insufficient margin to open position"),/td>/tr>tr>td>CROSS_DEPOSIT_DATA_ERROR/td>td>("Deposit error"),/td>/tr>tr>td>CROSS_DEPOSIT_CURRENCY_ID_AMOUNT_CHANGED/td>td>("Deposit error. {currencyId}, {amount}"),/td>/tr>tr>td>CROSS_WITHDRAW_WALLET_BALANCE_NOT_ENOUGH/td>td>("Insufficient wallet balance."),/td>/tr>tr>td>CROSS_WITHDRAW_DATA_ERROR/td>td>("Cross-chain withdrawal error"),/td>/tr>tr>td>CROSS_WITHDRAW_ID_NOT_FOUND/td>td>("Cross-chain withdrawal error. {withdrawId}"),/td>/tr>tr>td>CROSS_WITHDRAW_INVALID_STATUS/td>td>("Cross-chain withdrawal error. {status}"),/td>/tr>tr>td>CROSS_WITHDRAW_GREETER_MAX_ABLE_AMOUNT/td>td>("Your withdrawal amount has exceeded the max. withdrawal limit, please try again."),/td>/tr>tr>td>CROSS_WITHDRAW_RISK_CHECK_FAILED/td>td>("Cross-chain withdrawal error"),/td>/tr>tr>td>CROSS_WITHDRAW_INVALID_ARGUMENT/td>td>("Cross-chain withdrawal error"),/td>/tr>tr>td>FAST_WITHDRAW_DATA_ERROR/td>td>("Fast withdrawal error."),/td>/tr>tr>td>FAST_WITHDRAW_GREETER_MAX_ABLE_AMOUNT/td>td>("Your withdrawal amount has exceeded the max. withdrawal limit, please try again."),/td>/tr>tr>td>FAST_WITHDRAW_RISK_CHECK_FAILED/td>td>("Fast withdrawal error."),/td>/tr>tr>td>FAST_WITHDRAW_INVALID_ARGUMENT/td>td>("Fast withdrawal error."),/td>/tr>tr>td>FAST_WITHDRAW_ID_NOT_FOUND/td>td>("Fast withdrawal error. {withdrawId}"),/td>/tr>tr>td>FAST_WITHDRAW_INVALID_STATUS/td>td>("Fast withdrawal error. {status}"),/td>/tr>tr>td>FAST_WITHDRAW_WALLET_BALANCE_NOT_ENOUGH/td>td>("Fast withdrawal unsuccessful, insufficient wallet balance."),/td>/tr>tr>td>DEPOSIT_ASSET_ID_INVALID/td>td>("Deposit error. {assetId}"),/td>/tr>tr>td>DEPOSIT_AMOUNT_INVALID/td>td>("Invalid deposit amount. {amount}"),/td>/tr>tr>td>DEPOSIT_ASSET_ID_AMOUNT_CHANGED/td>td>("Data error! Incorrect deposit amount.. {assetId},{amount}"),/td>/tr>tr>td>DEPOSIT_STATUS_INVALID/td>td>("Data error! Incorrect deposit status. {status}"),/td>/tr>tr>td>DEPOSIT_CENSOR_ROUND_CONFLICT/td>td>(" Deposit censor round conflict. {censorRound}"),/td>/tr>tr>td>DEPOSIT_ID_NOT_FOUND/td>td>("Data error! Incorrect deposit ID. {depositId}"),/td>/tr>tr>td>WITHDRAW_INVALID_ARGUMENT/td>td>("Client withdrawal data conflict."),/td>/tr>tr>td>WITHDRAW_WALLET_BALANCE_NOT_ENOUGH/td>td>("Withdrawal unsuccessful, insufficient wallet balance."),/td>/tr>tr>td>WITHDRAW_CANNOT_FIND_WITHDRAW/td>td>("Withdrawal error. ${withdrawId}"),/td>/tr>tr>td>WITHDRAW_CENSOR_ROUND_CONFLICT/td>td>("Withdraw censor round conflict. ${censorRound}"),/td>/tr>tr>td>WITHDRAW_INVALID_STATUS/td>td>("Withdrawal status invalid. ${status}"),/td>/tr>tr>td>TRANSFER_WITH_SAME_ACCOUNT/td>td>("invalid parameters, transfer with same account. ${accountId}"),/td>/tr>tr>td>TRANSFER_CONDITION_FACT_REG_ADDRESS_EMPTY/td>td>("conditionFactRegistryAddress is empty"),/td>/tr>tr>td>TRANSFER_CONDITION_FACT_EMPTY/td>td>("conditionFact is empty"),/td>/tr>tr>td>NOT_CONDITION_TRANSFER_IN/td>td>("Not condition transferIn. ${transferInId}"),/td>/tr>tr>td>NOT_CONDITION_TRANSFER_OUT/td>td>("Not condition transferOut. ${transferOutId}"),/td>/tr>tr>td>TRANSFER_IN_STATUS_INVALID/td>td>("transferIn status invalid. ${status}"),/td>/tr>tr>td>TRANSFER_OUT_STATUS_INVALID/td>td>("transferOut status invalid. {status}"),/td>/tr>tr>td>TRANSFER_OUT_CENSOR_ROUND_CONFLICT/td>td>("transferOut censor round conflict. ${censorRound}"),/td>/tr>tr>td>TRANSFER_IN_CENSOR_ROUND_CONFLICT/td>td>("transferIn censor round conflict. {censorRound}"),/td>/tr>tr>td>CLIENT_TRANSFER_OUT_DATA_CONFLICT/td>td>("Client transfer out data conflict. ${clientTransferId}"),/td>/tr>tr>td>TRANSFER_WALLET_BALANCE_NOT_ENOUGH/td>td>("Cannot transfer out, wallet balance not enough."),/td>/tr>/tbody>/table> /div> div classdark-box> div classlang-selector> a href# data-language-nameshell>shell/a> a href# data-language-namepython>python/a> /div> /div> /div> /body>/html>

Subdomains

Date	Domain	IP
qa.pro.apex.exchange	2026-01-13	138.113.24.210
api-docs.qa.pro.apex.exchange	2026-03-04	3.175.34.52
tg-testnet.pro.apex.exchange	2025-08-16	54.169.141.124

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > api-docs.qa.pro.apex.exchange

Is this malicious?

DNS Resolutions

Port 80

Port 443

Subdomains