developers.quoine.comQuoine Exchange API Reference

NAV ruby Introduction API Version The base URL for Quoinex production is https://api.liquid.com/ . All responses are in JSON format with the following status codes: HTTP 200: OK Response is correct. The body of the response will include the data requested. HTTP 400: Bad Request There was an error with the request. The body of the response will have more info HTTP 401: Unauthorized Token is invalid. If your API key is wrong a 401 will also be served, so check the response body, it might be that the API_KEY is invalid. HTTP 422: Unprocessable Entity There was an error with the request. The body of the response will have more info. Some possible reasons: - Missing params - The format of data is wrong HTTP 429: Too Many Requests This status indicates that the user has sent too many requests in a given amount of time HTTP 503: Service Unavailable Many reasons, body will include details - An internal error on Authy. - Your application is accessing an API call you don't have access too. - API usage limit. If you reach API usage limits a 503 will be returned, please wait until you can do the call again. The current API version is 2. Please include the following header in the request to get correct API behaviors. Header Value X-Quoine-API-Version 2 Rate Limiting API users should not make more than 300 requests per 5 minute. Requests go beyond the limit will return with a 429 status Authentication require 'uri' require 'net/http' require 'time' require 'jwt' uri = URI . parse ( "https://api.liquid.com" ) http = Net :: HTTP . new ( uri . host , uri . port ) http . use_ssl = true token_id = 'YOUR_API_TOKEN_ID' user_secret = 'YOUR_API_SECRET' path = '/orders?product_id=1' auth_payload = { path: path , nonce: DateTime . now . strftime ( '%Q' ), token_id: token_id } signature = JWT . encode ( auth_payload , user_secret , 'HS256' ) request = Net :: HTTP :: Get . new ( path ) request . add_field ( 'X-Quoine-API-Version' , '2' ) request . add_field ( 'X-Quoine-Auth' , signature ) request . add_field ( 'Content-Type' , 'application/json' ) response = http . request ( request ) Authentication requires 2 parameters: API Token ID and API Secret . These parameters can be obtained from API Setting page We use JSON Web Token open standard for Authentication: First you need to build an auth payload, which includes the following parameters: Auth Payload Parameters: Parameters Optional? Description path request path, e.g /orders?product_id=1 nonce a strictly increasing number, uniquely created for each request. We recommend using a millisecond timestamp at the time of making request, e.g 1459142524488 token_id Token ID After constructing the auth payload, you need to sign it with your secret using HMAC-SHA256 (HS256). JWT.encode(auth_payload, user_secret, 'HS256') You can choose to manually sign by following JWT specs . But we highly recommend using a JWT library , which is available in a wide range of programming languages. Request Header: Parameters Optional? Description X-Quoine-Auth Signature obtained from signing the Auth Payload Types Timestamps 1457974024 (for 2016-03-14T16:47:04 in ISO 8601) Unless otherwise specified, all timestamps from API are returned in Unix Time . Numbers Decimal numbers are returned as strings to avoid floating precision errors. Integer numbers (including IDs) are unquoted. Errors Due to legacy reason, there are 2 type of error responses: Message { "message" : "missing parameters" } The message will be in the requester default language. For public api, please request with HTTP_ACCEPT_LANGUAGE header set to your preferred language Code Code with the following structure will be returned { “errors”: {“object”: [“errors list”]} } { "errors" : { "user" :[ "not_enough_fund" ]} } Pagination { "models" : [ "<json objects>" ], "current_page" : "<current page>" , "total_pages" : "<number of pages>" } Unless otherwise specified, all API requesting lists will be paginated with the following format: The default number of items returned is 20. To get more, you can specify parameter `limit`. For example GET /trades?limit=100. Note that the maximum number of items we can return at a time is 1000 I. Public API Public API does not require authentication Products Get Products GET /products [ { "id" : 5 , "product_type" : "CurrencyPair" , "code" : "CASH" , "name" : "CASH Trading" , "market_ask" : "48203.05" , "market_bid" : "48188.15" , "indicator" : -1 , "currency" : "JPY" , "currency_pair_code" : "BTCJPY" , "symbol" : "Â¥" , "fiat_minimum_withdraw" : "1500.0" , "pusher_channel" : "product_cash_btcjpy_5" , "taker_fee" : "0.0" , "maker_fee" : "0.0" , "low_market_bid" : "47630.99" , "high_market_ask" : "48396.71" , "volume_24h" : "2915.627366519999999998" , "last_price_24h" : "48217.2" , "last_traded_price" : "48203.05" , "last_traded_quantity" : "1.0" , "quoted_currency" : "JPY" , "base_currency" : "BTC" , "exchange_rate" : "0.009398151671149725" , "timestamp" : "1576739219.195353100" }, ... ] Get the list of all available products. Get Perpetual Products GET /products?perpetual=1 [ { "id" : "603" , "product_type" : "Perpetual" , "code" : "CASH" , "name" : null , "market_ask" : "1143900" , "market_bid" : "1143250" , "currency" : "JPY" , "currency_pair_code" : "P-BTCJPY" , "pusher_channel" : "product_cash_p-btcjpy_603" , "taker_fee" : "0.0" , "maker_fee" : "0.0" , "low_market_bid" : "1124450.0" , "high_market_ask" : "1151750.0" , "volume_24h" : "0.1756" , "last_price_24h" : "1129850.0" , "last_traded_price" : "1144700.0" , "last_traded_quantity" : "0.014" , "quoted_currency" : "JPY" , "base_currency" : "P-BTC" , "tick_size" : "50.0" , "perpetual_enabled" : true , "index_price" : "1142636.03935" , "mark_price" : "1143522.18417" , "funding_rate" : "0.00033" , "fair_price" : "1143609.31009" , "timestamp" : "1581558659.195353100" , } , ... ] Get the list of all available perpetual products. Get a Product GET /products/:id { "id" : 5 , "product_type" : "CurrencyPair" , "code" : "CASH" , "name" : "CASH Trading" , "market_ask" : "48203.05" , "market_bid" : "48188.15" , "indicator" : -1 , "currency" : "JPY" , "currency_pair_code" : "BTCJPY" , "symbol" : "Â¥" , "fiat_minimum_withdraw" : "1500.0" , "pusher_channel" : "product_cash_btcjpy_5" , "taker_fee" : "0.0" , "maker_fee" : "0.0" , "low_market_bid" : "47630.99" , "high_market_ask" : "48396.71" , "volume_24h" : "2915.62736652" , "last_price_24h" : "48217.2" , "last_traded_price" : "48203.05" , "last_traded_quantity" : "1.0" , "quoted_currency" : "JPY" , "base_currency" : "BTC" , "exchange_rate" : "0.009398151671149725" , "timestamp" : "1576739219.195353100" } Parameters: Parameters Optional? Description id Product ID Get Order Book GET /products/:id/price_levels { "buy_price_levels" : [ [ "416.23000" , "1.75000" ], ... ], "sell_price_levels" : [ [ "416.47000" , "0.28675" ], ... ], "timestamp" : "1576729943.772247300" } Parameters: Parameters Optional? Description id Product ID full yes 1 to get all price levels (default is 20 each side) Format Each price level follows: [ price , amount ] Executions Get Executions GET /executions?product_id=1&limit=2&page=2 Success Response: { "models" : [ { "id" : 1011880 , "quantity" : "6.118954" , "price" : "409.78" , "taker_side" : "sell" , "created_at" : 1457370745 }, { "id" : 1011791 , "quantity" : "1.15" , "price" : "409.12" , "taker_side" : "sell" , "created_at" : 1457365585 } ], "current_page" : 2 , "total_pages" : 1686 } Get a list of recent executions from a product (Executions are sorted in DESCENDING order - Latest first) Parameters Optional? Description product_id Product ID limit yes How many executions should be returned. Must be <= 1000. Default is 20 page yes From what page the executions should be returned, e.g if limit=20 and page=2, the response would start from the 21st execution. Default is 1 Get Executions by Timestamp GET /executions?product_id=1&timestamp=1430630863&limit=2 Success Response: [ { "id" : 960598 , "quantity" : "5....