{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b9070483-dd13-488d-8434-772fbbc9146b","name":"Bitenium Future API","description":"# Bitenium Future API Document\n\n[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)\n## General Info\n-------------\n\n### General Info\nAPI Key and API secret key generate in **setting** menu in wallet page.\n\n#### General API Information\n\n- The base endpoint is: **https://api.bitenium.com/futureapi**\n- The base websocket is: **ws://streamfuture.bitenium.com:9443**\n- All endpoints return either a JSON object or array.\n- All time and timestamp related fields are in **milliseconds**.\n\n#### Frequency limiting rules\nGet assets 3 times per second, other methods 10 times per second for each single user, 1000 times per minute for each single IP, exceeding the requested times, account will be locked for 10 minutes.\n\n#### Endpoint security type\n- Each endpoint has a security type that determines how you will interact with it. This is stated next to the NAME of the endpoint.\n- API-keys are passed into the Rest API via the X-MBX-APIKEY header.\n- API-keys and secret-keys are case sensitive.\n- API-keys can be configured to only access certain types of secure endpoints. For example, one API-key could be used for TRADE only, while another API-key can access everything except for TRADE routes.\n\n\n<br />\n\n#### Signature Statement\nThe request of API is likely to be tampered during the transmission through the Internet. In order to ensure that the request has not been changed, private interfaces other than public interfaces (basic information, market data) must use your API Key for signature verification to verify and check whether the parameter or parameter value has changed during the transmission. Each API Key needs proper permissions to access the corresponding interface. Every newly created API Key needs to be assigned permissions. Permission types are divided into: read, transaction and withdrawal. Before using the interface, please check the permission type of each interface and confirm that your API Key has the corresponding permission.\n\nA legitimate request consists of the following parts:\n\nWay to request an address: Accessing the server address **api.bitenium.com** such as **api.bitenium.com/futureapi/api/order**.\n\nAPI accesskey: There is the Access Key in the API Key you applied for.\n\nTimestamp (nonce): The timestamp of your application's request, 13-bit milliseconds. UBIEX will verify the validity of your API request based on this timestamp.\n\nSignature: A value calculated by the signature to ensure the signature is valid and has not been tampered. UBIEX uses HmacSHA256.\n\n<br />\n\n#### Signing steps\nStandardize the request to calculate signature. When HMAC is used for signature calculation, the calculation result using different content will be completely different. Therefore, before performing signature calculation, please standardize the request. The following takes the query of an order details request as an example:\n\n`https://api.bitenium.com/futureapi/api/order?orderId={OrderId}&timestamp={Timestamp}&signature={Signature}`\n\n\n`orderId = OrderId & timestamp = 1562919832183`\n\nNote that the value of nonce is a 13-bit millisecond number.\n\nUse the Secret Key obtained from the website to sign the HmacSHA256 parameter string generated above.\n\nFor example, the signature of the above parameters results:\n\n`13a158f3971db3fedf97a4eee092d5f4bfe05d574b0776be114ec03a3153872e`\n\nFinally, the signature is assigned to the parameter name signature and submitted to the server.\n\n<br/>\n\n### Order Status\nStatus  | information\n-|:-\nOPENED\t| The order has been accepted by the engine.\nPARTIALFILLED\t| A part of the order has been filled.\nFILLED\t| The order has been open position.\nREJECTED\t| The order was not accepted by the engine and not processed.\nCANCELLED\t| The order has been canceled by the user.\nEXPIRIED\t| he order was canceled according to the order type's rules\nCLOSED\t| The order has been close position and net balance profit\n\n<br/>\n\n#### Order types\n- MARKET\n- LIMIT\n\n<br/>\n\n#### Side\n- BUY\n- SELL\n\n<br/>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9543205","team":1049148,"collectionId":"b9070483-dd13-488d-8434-772fbbc9146b","publishedId":"TzRUB6v3","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9543205/TzRUB6v3","privateUrl":"https://go.postman.co/documentation/9543205-b9070483-dd13-488d-8434-772fbbc9146b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"02A2F8"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-05-12T07:43:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Bitenum Future","id":"b2497690-560d-4555-84d1-3375a1f6541c","owner":"9543205","values":[{"key":"url","value":"http://localhost/BiteniumRestFutureAPI","enabled":true},{"key":"bitenium-api-key","value":"api-key","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/3bc282daf65eb2a83013c15ee5756cf2a971db9ec659d75a341ca67b04dd8cea","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Bitenum Future","value":"9543205-b2497690-560d-4555-84d1-3375a1f6541c"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TzRUB6v3"}