The Orderbook API enables seamless trading on decentralized cryptocurrency perpetual futures markets, allowing users to place market and limit orders, manage positions, and track trade history with real-time updates for executing advanced strategies efficiently.
\nThe base endpoint is
\nTimestamp are format as Unix Timestamp in millisec unit
\nDefault Rate Limit: 50 request per second
\nAll GET endpoint are public and does not require any authentication
\nAll response will return in the following format for success response
\n{\n \"code\": 200,\n \"message\": \"Some message\",\n \"data\": {},\n \"timedtamp\": 1739166143822763 // server timestamp in microsecond\n}\n\nAll error response will return in the following format
\n{\n \"code\": 40x,\n \"message\": \"Some error message\"\n \"errors\" : \"\" // optional\n}\n\nDeposit and Withdrawal need to be done via smart contract call.
\ncall deposit function at Vault contract
\nfunction deposit(address _tokenAddress, bytes32 _subaccount, uint256 _amount);Wait for our off-chain sequencer to process the deposit request
\nOnce the deposit request is processed, call GET Subaccount Summary to confirm the collateral balance
\ncall withdrawal function at Vault contract
\nfunction withdraw(address _tokenAddress, bytes32 _subaccount, uint256 _amount);Wait for our off-chain sequencer to process the withdrawal request
\nOnce the withdrawal request is processed, the token will be transfered back to the wallet owner
\nGenerate JWT token by signing a pre-format message. The JWT token is required to trade via API
\nFollow the following step to generate JWT for the subaccount
\nGenerate a signature from the following message format using https://eips.ethereum.org/EIPS/eip-191
Please make sure the ${wallet_address} is in lower case.
generate jwt for ${wallet_address} and subaccount id ${subaccount_id} to trade on happytrading.global with nonce: ${nonce}`
nonce generation can be found in the below section
Call the auth endpoint to get JWT token
\nNonce are generated in the following format
\ntimestamp_ms(44 bit) + random_number(20 bit)
\nMost significant 44 bits encoding the time in milliseconds (a recv_time) after which the order will be rejected
Least significant 20 bits are a random integer used to order being replayed
For example, to place an order with a random integer of 1234, and a discard time 100 ms from now, we would send a nonce of ((timestamp_ms() + 100) << 20) + 1234)
Example,
\ntimestamp_ms = 1736686079528
\ntimestamp_ms << 20 = 1821047342527152128
\nrandom_number = 987895
\nnonce = 1821047342527152128 + 987895 = 1821047342528140023
\nOur protocol operates on subaccount in stead of account.
\nSubaccount is expressed as follow
\nsubaccount is 32 bytes that consist of account + subaccountId
\naccount: The wallet address (20 bytes)
\nsubaccount: Any number from 0 to maximum off 12 bytes.
\nThe Place New Order endpoint enables users to create a new order in the perpetual futures market. Users can choose between different order types—such as market, limit, stop, or conditional orders—by specifying relevant parameters, including market pair, price, quantity, and side (buy or sell). Additional options like time-in-force (e.g., Good Till Canceled, Immediate or Cancel) and post-only flags can be set to fine-tune the order behavior according to specific trading strategies.
\nIn order to place stop order, send the order type to be
\nStop
\nStopMarket
\nTakeProfit
\nTakeProfitMarket
\nFor Stop and TakeProfit order, trigger_price need to be sent along with the order with the following condition.
\nPerform the same function as Place Order endpoint. Traders can send multiple orders for execution to reduce the network round trip time.
\nThe Cancel Order endpoint allows users to cancel their open orders within the perpetual futures market. By specifying the order ID, users can target a specific order to be canceled. Alternatively, the endpoint supports bulk cancellation, enabling users to cancel all open orders for a particular market or across all markets in a single request. Once a cancellation request is processed, the response will include details such as the status of the cancellation, order digest(s), and any remaining quantities that were not executed. This endpoint is designed to provide fast and efficient order management, allowing users to quickly adapt to changing market conditions.
\nNote
\nThe Cancel Multiple Orders endpoint provides users with the ability to cancel multiple open orders simultaneously. Users can submit a list of order IDs to cancel specific orders in one go, streamlining the process for managing multiple trades. Additionally, the endpoint supports market-wide cancellation, where all open orders for a given market can be canceled with a single request. The response will include the status of each cancellation, confirming which orders were successfully canceled and providing relevant details for any that were not. This feature enhances efficiency for users managing large volumes of orders and allows for rapid adjustments to trading strategies.
\n","urlObject":{"path":["v2","batch-cancel-order"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b8d1a2b1-b28f-4315-899e-ce5bf24baeae","name":"BATCH Cancel Multiple Orders","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"symbol\": \"BTCUSD\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae33\",\n \"nonce\": \"19583094395023\",\n \"is_conditional_order\": false\n },\n {\n \"symbol\": \"BTCUSD\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae35\",\n \"nonce\": \"19583094395023\",\n \"is_conditional_order\": false\n },\n {\n \"symbol\": \"BTCUSD\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae36\",\n \"nonce\": \"19583094395023\",\n \"is_conditional_order\": false\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{base_url}}/v2/batch-cancel-order"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": {\n \"processed_orders\": 3,\n \"result_orders\": [\n {\n \"status\": \"Success\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae33\",\n \"client_order_id\": null\n },\n {\n \"status\": \"OrderNotFound\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae35\",\n \"client_order_id\": null\n },\n {\n \"status\": \"AlreadyCanceledOrFilled\",\n \"order_digest\": \"0x000000000000000000000000000000000000000000000000000000000178ae36\",\n \"client_order_id\": null\n }\n ]\n },\n \"timestamp\": 1740655001685043\n}"}],"_postman_id":"f3748992-6520-463e-9d00-dc6966769c8f"},{"name":"Cancel All Resting Orders","id":"fbb13b20-3f6d-4939-8b54-28f57cf22ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer AUTH_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"symbol\": \"This endpoint will cancel all of the resting orders. If the market symbol is specified, only the orders in that market will be canceled
\nNote
\nIf is_conditional_order is not sent, cancel all order both resting and conditional order
\nIf is_conditional_order is true, cancel only conditional orders
\nIf is_conditional_order is false, cancel only resting orders
\nThe Order Management endpoints provide users with the functionality to create and cancel orders within the perpetual futures market. These endpoints include:
\nCreate Order: Allows users to place new orders, such as market, limit, stop, or conditional orders. Users can specify key parameters like the market pair, price, quantity, and order type. Advanced options such as time-in-force and post-only orders are also available for flexible trading strategies.
\nCancel Order: Enables users to cancel open orders that have not been fully executed. Users can cancel individual orders by specifying the order ID or cancel all open orders for a specific market in bulk.
\nBatch Order Creation and Cancellation: Supports batch requests to create or cancel multiple orders in a single operation, providing an efficient way to handle high trading volumes.
\nThese endpoints are designed to facilitate quick and reliable order placement and management, giving users full control over their trading activities in real-time.
\nIn order to get the token, please refer to Authentication section
\nProvide the JWT access token in the Authorization header
\nExample
\nEvery request should be attached with a string called \"nonce\".
\nNonce are generated in the following format
\ntimestamp_ms(44 bit) . random_number(20 bit)
\nMost significant 44 bits encoding the time in milliseconds (a recv_time) after which the order will be rejected
Least significant 20 bits are a random integer used to order being replayed
For example, to place an order with a random integer of 1234, and a discard time 100 ms from now, we would send a nonce of ((timestamp_ms() + 100) << 20) + 1234)
Our backend support multiple Frontend Interfaces. Each frontend has Broker ID associate to it. Please contact our tech support to see check which Broker ID to use.
\nEach Broker ID has different fee structure.
\nThe Order History endpoint allows users to retrieve detailed records of their past orders on the perpetual futures market. This includes information on all types of orders, such as market, limit, and stop orders, along with their respective statuses (e.g., filled, partially filled, canceled). Each order history entry provides key details like order ID, timestamp, market, order type, quantity, price, execution status, and any relevant fees. Users can filter and sort this historical data based on time periods, order types, or market pairs to effectively track their trading activities, analyze their performance, and maintain a record for audit or review purposes.
\n","urlObject":{"path":["v2","order-history",":subaccount"],"host":["{{base_url}}"],"query":[{"description":{"content":"from (timestamp in seconds); default 90 days ago
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"to (timestamp in seconds); default Now
\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"The index of the pages
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Filter only active order
\n","type":"text/plain"},"key":"active","value":""}],"variable":[{"description":{"content":"(Required) wallet address with subaccount number padding zero in bytes32
\n\n\ne.g. 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1
\n
\n\n","type":"text/plain"},"type":"any","value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE","key":"subaccount"}]}},"response":[{"id":"02bb7af0-a220-4afe-8b2f-c1ccef936b79","name":"Get Order History","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v2/order-history/:subaccount?from=1724642559&to=1727320959&page=1&active=true","host":["{{base_url}}"],"path":["v2","order-history",":subaccount"],"query":[{"key":"from","value":"1724642559","description":"from (timestamp in seconds); default 90 days ago"},{"key":"to","value":"1727320959","description":"to (timestamp in seconds); default Now"},{"key":"page","value":"1","description":"The index of the pages"},{"key":"active","value":"true","description":"Filter only active order"}],"variable":[{"key":"subaccount","value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001","description":"(Required) wallet address with subaccount number padding zero in bytes32 \n\n \n>***e.g.*** 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1 \n\n \n>GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"order_digest\": \"0x71d8167b1d91401b41babd37a6bdc8596c1fd725931f8210c514be382279bdc6\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"symbol\": \"BTCUSD\",\n \"side\": \"Short\",\n \"order_type\": \"Limit\",\n \"quantity\": \"11.36234519000000000000000000\",\n \"filled_qty\": \"0\",\n \"price\": \"88010.0000000000\",\n \"avg_filled_price\": \"0.00\",\n \"time_in_force\": \"PostOnly\",\n \"is_reduce_only\": false,\n \"is_liquidation\": false,\n \"created_at\": 1730364493000,\n \"updated_at\": 1730364493000,\n \"canceled_at\": 1730364493000,\n \"expired_at\": null,\n \"trigger_above_threshold\": null,\n \"trigger_price\": null\n }\n ],\n \"timestamp\": 1739168105871471\n}\n"}],"_postman_id":"548eee20-24ec-4030-98b3-dbbde6856175"},{"name":"Search Order History by Digest","id":"92d622af-fe89-4e35-8a49-ea1f683150d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/order-history-digest?order_digests=order_digest1, order_digest2 ...","description":"GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n
\n
Get specific order history providing the order digest or multiple order digests
\n","urlObject":{"path":["v2","order-history-digest"],"host":["{{base_url}}"],"query":[{"key":"order_digests","value":"order_digest1, order_digest2 ..."}],"variable":[]}},"response":[{"id":"ed6b26dd-2803-449f-a7a9-dd6989a02489","name":"Search Order History by Digest","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v2/order-history-digest?order_digests=0x00000000000000000000000000000000000000000000000000000000002a2541,0x00000000000000000000000000000000000000000000000000000000002a2542","host":["{{base_url}}"],"path":["v2","order-history-digest"],"query":[{"key":"order_digests","value":"0x00000000000000000000000000000000000000000000000000000000002a2541,0x00000000000000000000000000000000000000000000000000000000002a2542"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": \"5094076\",\n \"order_digest\": \"0x00000000000000000000000000000000000000000000000000000000002a2541\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"symbol\": \"ETHUSD\",\n \"side\": \"Short\",\n \"order_type\": \"Limit\",\n \"quantity\": \"6.007\",\n \"filled_qty\": \"0.132\",\n \"price\": \"2692.27\",\n \"avg_filled_price\": \"0.00\",\n \"time_in_force\": \"PostOnly\",\n \"is_reduce_only\": false,\n \"is_liquidation\": false,\n \"created_at\": 1739936734680,\n \"updated_at\": 1739936740241,\n \"canceled_at\": 1739936739809,\n \"expired_at\": null,\n \"trigger_above_threshold\": null,\n \"trigger_price\": null,\n \"is_conditional_order\": false\n },\n {\n \"id\": \"5094077\",\n \"order_digest\": \"0x00000000000000000000000000000000000000000000000000000000002a2542\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"symbol\": \"ETHUSD\",\n \"side\": \"Short\",\n \"order_type\": \"Limit\",\n \"quantity\": \"6.007\",\n \"filled_qty\": \"0.132\",\n \"price\": \"2692.27\",\n \"avg_filled_price\": \"0.00\",\n \"time_in_force\": \"PostOnly\",\n \"is_reduce_only\": false,\n \"is_liquidation\": false,\n \"created_at\": 1739936734680,\n \"updated_at\": 1739936740241,\n \"canceled_at\": 1739936739809,\n \"expired_at\": null,\n \"trigger_above_threshold\": null,\n \"trigger_price\": null,\n \"is_conditional_order\": false\n }\n ],\n \"timestamp\": 1739957367011175\n}"}],"_postman_id":"92d622af-fe89-4e35-8a49-ea1f683150d5"},{"name":"Get Payment History","id":"6e4e8f81-1da8-4b15-a115-2386b79d12a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/payment-history/:subaccount?types=&from=&to=&page=","description":"The Payment History endpoint provides users with a comprehensive record of all financial transactions related to their account within the perpetual futures market. This includes deposits, withdrawals, fees, and any adjustments or transfers within the platform. Each payment record includes details such as timestamp, type (e.g., deposit, withdrawal, fee), amount, asset, and status (e.g., completed, pending, failed). Users can filter and query this data based on date ranges, transaction types, and currencies to efficiently track their financial activity, reconcile account balances, and ensure the accuracy of their payments and account movements.
\n","urlObject":{"path":["v2","payment-history",":subaccount"],"host":["{{base_url}}"],"query":[{"description":{"content":"payment type example (LiquidationFee, FundingFee)
\n","type":"text/plain"},"key":"types","value":""},{"description":{"content":"from (timestamp in seconds); default 90 days ago
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"to (timestamp in seconds); default Now
\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"page
\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"description":{"content":"(Required) wallet address with subaccount number padding zero in bytes32
\n\n\ne.g. 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1
\n
\n\n","type":"text/plain"},"type":"any","value":"GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n
\n
The Position History endpoint enables users to view a detailed log of all their closed positions within the perpetual futures market. Each entry in the position history provides comprehensive information, including the market, entry and exit prices, position size, realized profits/losses, and the timestamps for when the position was opened and closed. Users can utilize this endpoint to analyze their trading strategies, review the performance of individual positions, and track their historical exposure across different markets.
\n","urlObject":{"path":["v2","position-history",":subaccount"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"(Required) wallet address with subaccount number padding zero in bytes32
\n\n\ne.g. 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1
\n
\n\n","type":"text/plain"},"type":"any","value":"","key":"subaccount"}]}},"response":[{"id":"9ad0db90-1290-4c9f-a24c-70386fd75947","name":"Get Position History","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v2/position-history/:subaccount","host":["{{base_url}}"],"path":["v2","position-history",":subaccount"],"variable":[{"key":"subaccount","value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001","description":"(Required) wallet address with subaccount number padding zero in bytes32 \n \n>***e.g.*** 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1 \n \n>GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n "}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"symbol\": \"BTCUSD\",\n \"side\": \"Short\",\n \"current_qty\": \"0.00\",\n \"max_qty\": \"26.705000000000000000000\",\n \"closed_qty\": \"26.705000000000000000000\",\n \"avg_entry_price\": \"86640.0000000000\",\n \"avg_close_price\": \"86640.0000000000\",\n \"realized_pnl\": \"0.00\",\n \"liquidated_at\": null,\n \"liquidated_price\": null,\n \"created_at\": 1730364493000,\n \"updated_at\": 1730364493000,\n \"closed_at\": 1730364493000\n }\n ],\n \"timestamp\": 1739168105871471\n}\n"}],"_postman_id":"b4abce7c-815f-4aa9-a0ee-35f95412b9a1"},{"name":"Get Trade History","id":"d52a09ba-308f-4863-83ca-8a85b4a7ba9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/trade-history/:subaccount?from&to&page","description":"GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n
\n
The Trade History endpoint allows users to access a detailed record of all executed trades on their account within the perpetual futures market. Each trade entry includes key details such as order digest, timestamp, market pair, trade side (buy or sell), price, quantity. This endpoint provides a comprehensive view of all trades, whether they resulted from being a maker or taker.
\n","urlObject":{"path":["v2","trade-history",":subaccount"],"host":["{{base_url}}"],"query":[{"description":{"content":"from (timestamp in seconds); default 90 days ago
\n","type":"text/plain"},"key":"from","value":null},{"description":{"content":"to (timestamp in seconds); default Now
\n","type":"text/plain"},"key":"to","value":null},{"description":{"content":"The index of the pages
\n","type":"text/plain"},"key":"page","value":null}],"variable":[{"description":{"content":"(Required) wallet address with subaccount number padding zero in bytes32
\n\n\ne.g. 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1
\n
\n\n","type":"text/plain"},"type":"any","value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE","key":"subaccount"}]}},"response":[{"id":"75b0196d-75d9-4f97-9b83-b4f87bb858d1","name":"Get Trade History","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v2/trade-history/:subaccount","host":["{{base_url}}"],"path":["v2","trade-history",":subaccount"],"variable":[{"key":"subaccount","value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001","description":"(Required) wallet address with subaccount number padding zero in bytes32 \n \n>***e.g.*** 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1 \n \n>GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n "}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"symbol\": \"BTCUSD\",\n \"side\": \"Long\",\n \"price\": \"86640.0000000000\",\n \"filled\": \"26.705000000000000000000\",\n \"trading_fee\": \"13.882327200000000\",\n \"trading_fee_token\": \"USDC\",\n \"realized_pnl\": \"0.00\",\n \"is_taker\": false,\n \"traded_at\": 1730364493000\n }\n ],\n \"timestamp\": 1739168105871471\n}\n"}],"_postman_id":"d52a09ba-308f-4863-83ca-8a85b4a7ba9e"},{"name":"Get Subaccount Summary","id":"f0f540d5-2612-4399-8eca-e4bb3f3fc6ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/subaccount-summary/:subaccount","description":"GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n
\n
The Subaccount Summary endpoint provides a overview of a user's subaccount current state. This includes:
\nCollateral: A list of all collateral balances.
\nOpen Orders: A list of all active orders, quantities, and markets.
\nOpen Positions: A snapshot of all current positions, including market exposure, entry price, position size
\nThis endpoint is the main endpount used for monitoring subaccount’s status.
\n","urlObject":{"path":["v2","subaccount-summary",":subaccount"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"(Required) wallet address with subaccount number padding zero in bytes32
\n\n\ne.g. 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE with subaccount number 1
\n
\n\n","type":"text/plain"},"type":"any","value":"GET /subaccount-summary/0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\n
\n
The History Endpoints provide users with access to key historical data for their trading activities on the perpetual futures market. This set includes:
\nOrder History: Details on all past orders, including type, status, and execution details.
\nTrade History: Records of executed trades with price, quantity, and timestamp.
\nPosition History: Information on open and closed positions, with entry/exit prices and P&L.
\nPayment History: Transactions related to deposits, withdrawals, and fees.
\nSubaccount History: Activity in subaccounts, covering collateral changes, open orders, and open positions.
\nThese endpoints allow users to review and analyze their trading history, financial transactions, and subaccount activities comprehensively.
\nThe Get Market Information endpoint provides essential details for all available markets for the particular Broker, including:
\nMarket Pair: The trading pair (e.g., BTC/USDT).
\nTick Size: Minimum price increment.
\nLot Size: Minimum contract quantity increment.
\nMin Notional Size: Minimum trade size.
\nIMF: Initial Margin Requirement
\nMaker Fee: Trading fee for maker order
\nTaker Fee: Trading fee for taker order
\nThis information helps users understand market specifications and constraints, ensuring accurate and compliant order placement.
\n","urlObject":{"path":["v2","market-info","brokers","{{broker_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0c739942-532d-44fa-8d7a-f8e30e64cbde","name":"Get Market Information","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v2/market-info/brokers/{{broker_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 1,\n \"symbol\": \"BTCUSD\",\n \"name\": \"BITCOIN / UNITED STATES DOLLAR\",\n \"base_asset\": \"BTC\",\n \"quote_asset\": \"USD\",\n \"imf\": \"0.05\",\n \"mmf\": \"0.025\",\n \"maker_fee\": \"-0.0001\",\n \"taker_fee\": \"0.00015\",\n \"price_feed_id\": 3,\n \"tick_size\": \"0.01\",\n \"lot_size\": \"0.0001\",\n \"min_notional_size\": \"10\",\n \"max_conditional_orders\": 20\n },\n {\n \"id\": 2,\n \"symbol\": \"ETHUSD\",\n \"name\": \"ETHEREUM / UNITED STATES DOLLAR\",\n \"base_asset\": \"ETH\",\n \"quote_asset\": \"USD\",\n \"imf\": \"0.05\",\n \"mmf\": \"0.025\",\n \"maker_fee\": \"-0.0001\",\n \"taker_fee\": \"0.00015\",\n \"price_feed_id\": 5,\n \"tick_size\": \"0.001\",\n \"lot_size\": \"0.0001\",\n \"min_notional_size\": \"10\",\n \"max_conditional_orders\": 20\n }\n ],\n \"timestamp\": 1739168105871471\n}"}],"_postman_id":"551b27ba-49ab-449d-bad3-cfe6fb42400e"},{"name":"Get Mark Prices","id":"8ea65ca3-3944-4295-8151-d77c9cee6f9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/mark-prices","description":"The Get Oracle Prices endpoint provides real-time price data from external oracles for all supported markets. This includes accurate and up-to-date price feeds that can be used to inform trading decisions, verify price movements, and manage risk. Each response includes the market pair, current oracle price, and timestamp of the last update, ensuring users have reliable pricing information for trading and analysis.
\n","urlObject":{"path":["v2","mark-prices"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8d42675a-fc9d-412e-b793-10218e916a0f","name":"Get Mark Prices","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v2/mark-prices"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"symbol\": \"BTCUSD\",\n \"mark_price\": \"100000.4923\",\n \"index_price\": \"100001.3983\"\n },\n {\n \"symbol\": \"ETHUSD\",\n \"mark_price\": \"3200.0211\",\n \"index_price\": \"3199.5340\"\n }\n ],\n \"timestamp\": 1739168105871471\n}\n"}],"_postman_id":"8ea65ca3-3944-4295-8151-d77c9cee6f9e"},{"name":"Get Collateral Prices","id":"4fa8ea71-473c-474e-b35d-6f0371bd58bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/collateral-prices","description":"The Get Oracle Prices endpoint provides real-time price data from external oracles for all supported markets. This includes accurate and up-to-date price feeds that can be used to inform trading decisions, verify price movements, and manage risk. Each response includes the market pair, current oracle price, and timestamp of the last update, ensuring users have reliable pricing information for trading and analysis.
\n","urlObject":{"path":["v2","collateral-prices"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f6ebdf40-9f8c-4927-8a60-13172e407373","name":"Get Collateral Prices","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v2/collateral-prices"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"collateral_id\": \"0x0000000000000000000000000000000000000001\",\n \"asset\": \"USDC\",\n \"price\": \"1.00008136\"\n }\n ],\n \"timestamp\": 1739168105871471\n}"}],"_postman_id":"4fa8ea71-473c-474e-b35d-6f0371bd58bd"}],"id":"d804ce82-19fb-4411-975d-c6c7465e696f","description":"List of API Endpoints return system configurations
\n","_postman_id":"d804ce82-19fb-4411-975d-c6c7465e696f"},{"name":"Price Data","item":[{"name":"Price Chart (Candle Sticks)","id":"544fd54a-a843-4ead-a001-7bf9c720c7c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/chart?symbol=&from&to&interval","description":"Market Symbol i.e. BTCUSD
\n","type":"text/plain"},"key":"symbol","value":""},{"description":{"content":"Starting time in unix timestamp format
\n","type":"text/plain"},"key":"from","value":null},{"description":{"content":"Ending Time in unix timstamp format
\n","type":"text/plain"},"key":"to","value":null},{"description":{"content":"Interval e.g 1m, 1H, 1D
\n","type":"text/plain"},"key":"interval","value":null}],"variable":[]}},"response":[{"id":"9c76ac1d-dc2f-4530-910a-1e14d7d95aee","name":"Price Chart (Candle Sticks)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v2/chart?symbol=BTC/USD&from=1730615871&to=1734935871&interval=4h","host":["{{base_url}}"],"path":["v2","chart"],"query":[{"key":"symbol","value":"BTC/USD"},{"key":"from","value":"1730615871"},{"key":"to","value":"1734935871"},{"key":"interval","value":"4h"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": {\n \"bars\": [\n {\n \"time\": 1734069600,\n \"open\": 96297.935,\n \"high\": 96297.935,\n \"low\": 96297.935,\n \"close\": 96297.935,\n \"volume\": 25402 // Unit in base currency\n },\n {\n \"time\": 1734069660,\n \"open\": 96297.935,\n \"high\": 96297.935,\n \"low\": 96297.935,\n \"close\": 96297.935,\n \"volume\": 40395023 // Unit in base currency\n // ....\n }\n ],\n \"symbol\": \"BTC/USD\",\n \"interval\": 60,\n \"from\": 1734069646,\n \"to\": 1734087646\n },\n \"timestamp\": 1739168105871471\n}"}],"_postman_id":"544fd54a-a843-4ead-a001-7bf9c720c7c6"},{"name":"24 Hr Price","id":"025eb7bb-be38-4006-9614-0702acdbd596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v2/ticker/24hr","urlObject":{"path":["v2","ticker","24hr"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3828c269-0262-4c6f-84a1-77ae14d0651c","name":"24 Hr Price","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v2/ticker/24hr"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"symbol\": \"BTCUSD\",\n \"current_price\": \"91317.81300000\",\n \"last_24hr_price\": \"87914.82100000\",\n \"price_change\": \"3402.99200000\",\n \"price_change_percent\": \"3.871\",\n \"volume\": \"1491370.06912800\"\n },\n {\n \"symbol\": \"ETH/USD\",\n \"current_price\": \"3119.68400000\",\n \"last_24hr_price\": \"3074.03600000\",\n \"price_change\": \"45.64800000\",\n \"price_change_percent\": \"1.485\",\n \"volume\": \"1007320.67740800\"\n },\n {\n \"symbol\": \"SOL/USD\",\n \"current_price\": \"210.00000000\",\n \"last_24hr_price\": \"210.25000000\",\n \"price_change\": \"-0.25000000\",\n \"price_change_percent\": \"-0.119\",\n \"volume\": \"0.00000000\"\n }\n ],\n \"timestamp\": 1739168105871471\n}"}],"_postman_id":"025eb7bb-be38-4006-9614-0702acdbd596"}],"id":"f7e9a4f3-f04c-4f47-b602-5be6667eaa9d","_postman_id":"f7e9a4f3-f04c-4f47-b602-5be6667eaa9d","description":""},{"name":"Websocket","item":[{"name":"L2Book Subscribe","id":"d8482ed6-9b08-4296-b6a5-3f6fe2c98130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"l2BookV2\",\n \"symbol\": \"BTCUSD\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"b129558e-d952-4b35-bb7f-625c8ec45210","name":"L2Book Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"l2Book\",\n \"symbol\": \"BTCUSD\",\n \"data\": {\n \"bids\": [\n [\n \"60500.00\", // Price\n \"20.00\" // Qty per level\n ]\n ],\n \"asks\": [\n [\n \"60700.00\", // Price\n \"10.00\" // Qty per level\n ]\n ]\n },\n \"timestamp\": 1739166143822763\n}"}],"_postman_id":"d8482ed6-9b08-4296-b6a5-3f6fe2c98130"},{"name":"Trades Subscribe","id":"52aaf596-29ea-4dc5-be77-d8c53cbd44b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"tradesV2\",\n \"symbol\": \"BTCUSD\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"8dde7bf5-bb3c-4eb5-95b1-f9bf708dd13f","name":"Trade Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"tradesV2\",\n \"symbol\": \"BTCUSD\",\n \"data\": {\n \"price\": \"60500.00\",\n \"qty\": \"1.00\",\n \"side\": \"Long\",\n \"client_order_id\": \"9e09a7f6-8438-4f0d-b01e-019c840d2190\",\n \"traded_at\": 1724647795532\n },\n \"timestamp\": 1739166143822763\n}"}],"_postman_id":"52aaf596-29ea-4dc5-be77-d8c53cbd44b8"},{"name":"Trades Updates Subscribe","id":"20989eee-55a7-4ca1-9cb4-632156c59042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"tradeUpdatesV2\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"7e0cb05d-f876-4568-a468-91f27ef500dc","name":"Trade Update Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"tradeUpdatesV2\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"data\": {\n \"symbol\": \"ETHUSD\",\n \"price\": \"4005.00\",\n \"quantity\": \"0.459\",\n \"is_taker\": true,\n \"side\": \"Long\",\n \"order_digest\": \"0x00000000000000000000000000000000000000000000000000000000003df7e5\",\n \"client_order_id\": \"9e09a7f6-8438-4f0d-b01e-019c840d2190\",\n \"traded_at\": 1739169110522\n },\n \"timestamp\": 1739169110635191\n}"}],"_postman_id":"20989eee-55a7-4ca1-9cb4-632156c59042"},{"name":"Mark Prices Subscribe","id":"526492e7-b9ca-422e-b7ab-ba810eb45052","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"markPricesV2\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"61841f75-37ce-4650-8ca9-7b513a82dc9d","name":"Mark Prices Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"markPrices\",\n \"data\": [\n {\n \"symbol\": \"BTCUSD\",\n \"mark_price\": \"60000.00\",\n \"index_price\": \"60000.00\"\n },\n {\n \"symbol\": \"ETHUSD\",\n \"mark_price\": \"3200.0200\",\n \"index_price\": \"3200.0022\"\n }\n ],\n \"timestamp\": 1739166143822763\n}\n"}],"_postman_id":"526492e7-b9ca-422e-b7ab-ba810eb45052"},{"name":"Order Updates Subscribe","id":"e5133da0-3870-4ad2-b735-10ee058b118f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"orderUpdatesV2\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"d68bcea6-34ea-45d5-a8f2-58c3915eb477","name":"Order Updates Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"orderUpdates\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"data\": {\n \"symbol\": \"BTCUSD\",\n \"avg_price\": \"60000.00\",\n \"original_quantity\": \"1.00\",\n \"filled_quantity\": \"1.00\",\n \"side\": \"Short\",\n \"order_type\": \"Limit\",\n \"tif\": \"PostOnly\",\n \"status\": \"Open\", // Open | Filled | Canceled | Expired\n \"order_updated_at\": 1724653836139,\n \"client_order_id\": \"my-id-1\",\n \"order_digest\" : \"0x...\"\n },\n \"timestamp\": 1739166143822763\n}"}],"_postman_id":"e5133da0-3870-4ad2-b735-10ee058b118f"},{"name":"Position Updates Subscribe","id":"e7abef83-af1b-4382-9e62-f39ac1b2f15c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"WSS","header":[],"body":{"mode":"raw","raw":"{\n \"method\": \"subscribe\",\n \"subscription\": {\n \"type\": \"positionUpdatesV2\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"986b3d8d-7efd-4009-a51e-4fcf1c429cb6","name":"Position Updates Subscribe","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"positionUpdates\",\n \"subaccount\": \"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE000000000000000000000001\",\n \"data\": {\n \"symbol\": \"BTCUSD\",\n \"quantity\": \"36.74\",\n \"avg_entry_price\": \"720444.0000\",\n \"side\": \"Short\"\n },\n \"timestamp\": 1739166143822763\n}"}],"_postman_id":"e7abef83-af1b-4382-9e62-f39ac1b2f15c"}],"id":"121cbf41-70e2-41df-ad3c-5d630075a6f3","description":"This documentation provides details on how to connect to the WebSocket server, subscribe to specific data streams, and interpret the responses received from the server.
\nThe base endpoint are
\ntestnet: wss://trade-ws-api.happytrading.global/ws
mainnet: wss://ws-api.happytrading.global/ws
Our server will terminate streams that are idle (OrderUpdate, PositionUpdate) for longer than 100 second. To keep the connection open, please send ping frame every 60s.
\n