### Example Response - All Account Balances Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_accounts.md An example JSON response showing the structure of the data returned for the 'Get All Account Balances' endpoint, representing a collection of account details. ```json [ { "asset": "BTC", "balance": "0", "locked": "0" } ] ``` -------------------------------- ### Example Response - Single Asset Balance Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_accounts.md An example JSON response showing the structure of the data returned for the 'Get Single Asset Balance' endpoint, representing the details for a single asset. ```json { "asset": "BTC", "balance": "0", "locked": "0" } ``` -------------------------------- ### Example Response - Get User Orders - BigONE API - JSON Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_orders.md Example JSON response body for the GET /private/orders endpoint. Returns an array of Order objects, each containing details like user ID, order ID, market, type, side, state, price, amount, filled amount, and timestamps. ```JSON [ { "user_id": "6b0ffa5e-a9ea-4913-b9b8-a84a32dd478c", "order_id": "cf4734e2-d859-4417-aa74-cc8c95a72776", "market": "ETH-BTC", "order_type": "LIMIT", "side": "BID", "state": "FILLED", "price": "1.2", "amount": "2", "filled": "2", "created_at": "2018-02-08T12:57:06.605327164Z", "updated_at": "2018-02-08T12:57:08.850330039Z" } ] ``` -------------------------------- ### Order Book JSON Response Example Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_order_books.md This snippet provides an example of the JSON structure returned by the /order_books endpoint, showing the format for ask and bid orders. ```JSON { "ask": [{ "price": "1.22148643", "amount": "9389.88250250" }], "bid": [{ "price": "0.22148643", "amount": "9389.88250250" }] } ``` -------------------------------- ### Example Withdrawal Response (JSON) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_withdrawal.md An example of the JSON structure returned by the GET /private/withdrawals endpoint. It represents a collection of Withdrawal objects, each containing details like user ID, asset, state, amount, address, and timestamps. ```JSON [ { "user_id": "6b0ffa5e-a9ea-4913-b9b8-a84a32dd478c", "asset": "ETH", "state": "initial", "tx_id": "", "amount": "2", "label": "111", "memo": "", "address": "0xD0b1EEBE6F289b9E3bE7C9925A8580a5C60704F1", "created_at": "2018-03-15T16:13:45.610463Z" } ] ``` -------------------------------- ### Market Trade Response JSON Example Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_market_trade.md This snippet provides an example of the JSON structure returned by the GET /markets/:market/trades endpoint. Each object in the array represents a single trade, including user ID, trade ID, market, side (ASK/BID), order ID, price, amount, and creation timestamp. ```JSON [ { "user_id": "6b0ffa5e-a9ea-4913-b9b8-a84a32dd478c", "trade_id": "0f0e1b61-a2d2-4d6a-8261-b27bfcd82977", "market": "ETH-BTC", "side": "ASK", "order_id": "224946b7-53c7-40d4-9ffe-a78a0199f478", "price": "1", "amount": "1", "created_at": "2018-02-08T07:40:12.022105731Z" } ] ``` -------------------------------- ### Example Deposit Response Structure Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_deposit.md An example of the JSON structure returned for a single deposit record within the collection. It shows typical fields like user ID, asset, state, transaction ID, amount, and creation timestamp. ```JSON [{ "user_id": "6b0ffa5e-a9ea-4913-b9b8-a84a32dd478c", "asset": "ETH", "state": "initial", "tx_id": "", "amount": "2", "created_at": "2018-03-15T16:13:45.610463Z" }] ``` -------------------------------- ### Example Response - Create Order - BigONE API - JSON Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_orders.md Example JSON response body for the POST /private/orders endpoint. Returns a JSON object containing the unique identifier ('order_id') of the newly created order. ```JSON { "order_id": "da023165-3e80-4cb9-980a-c0f13d30bf6f" } ``` -------------------------------- ### Contributing to BigONE Developer API Source: https://github.com/inblockchain/bigone-developer-api/blob/master/README.md These commands outline the steps required to set up the local development environment for contributing to the BigONE Developer API project. It involves cloning the repository, navigating to the website directory, and starting the development server. ```Shell clone project cd website yarn start ``` -------------------------------- ### Get Order Book HTTP Request Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_order_books.md This snippet shows the HTTP GET request path for retrieving the order book of a market. It requires the 'market' parameter. ```HTTP GET /order_books ``` -------------------------------- ### User Trades API Response Example (JSON) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_trade.md This snippet provides an example of the JSON structure returned by the /private/trades endpoint. It is an array of Trade objects, each containing details like user ID, trade ID, market, side, order ID, price, amount, and creation timestamp. ```JSON [ "user_id": "6b0ffa5e-a9ea-4913-b9b8-a84a32dd478c", "trade_id": "0f0e1b61-a2d2-4d6a-8261-b27bfcd82977", "market": "ETH-BTC", "side": "ASK", "order_id": "224946b7-53c7-40d4-9ffe-a78a0199f478", "price": "1", "amount": "1", "created_at": "2018-02-08T07:40:12.022105731Z" }] ``` -------------------------------- ### Get All Account Balances - BigONE API Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_accounts.md Retrieves the balance and locked amount for all assets in the user's account via a GET request to the private accounts endpoint. ```http GET /private/accounts ``` -------------------------------- ### Get User Trades API Endpoint (HTTP) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_trade.md This snippet shows the HTTP GET endpoint path used to retrieve a list of trades for the authenticated user. It requires authentication and accepts parameters for pagination and market filtering. ```HTTP GET /private/trades ``` -------------------------------- ### GET Market Trades HTTP Request Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_market_trade.md This snippet shows the HTTP GET request path to retrieve the latest trades for a specified market. The ':market' parameter should be replaced with the desired market name (e.g., 'ETH-BTC'). The endpoint returns a maximum of 50 latest trades. ```HTTP GET /markets/:market/trades ``` -------------------------------- ### Getting User Orders - BigONE API - HTTP Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_orders.md Retrieves a list of the authenticated user's orders for a specific market. Supports filtering by state and pagination. Requires market name and optionally state, page, and per_page parameters. ```HTTP GET /private/orders ``` -------------------------------- ### Get all market tickers (REST) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_tickers.md Retrieves the ticker information for all available markets. The response is a collection (array) of Ticker objects, each containing details like ask, bid, high, low, last price, market name, and volume. ```HTTP GET /tickers ``` -------------------------------- ### Get User Deposits Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_deposit.md Retrieves a collection of user deposit records via the private API endpoint. Requires read permission for the user's wallet. ```HTTP GET /private/deposits ``` -------------------------------- ### Get Single Asset Balance - BigONE API Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_accounts.md Retrieves the balance and locked amount for a specific asset in the user's account by providing the asset name in the URL path. ```http GET /private/accounts/{asset} ``` -------------------------------- ### Get ticker for a specific market (REST) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_tickers.md Retrieves the ticker information for a single specified market. Requires the market name (e.g., ETH-BTC) as a path parameter. The response is a single Ticker object with details for the requested market. ```HTTP GET /tickers/{market} ``` -------------------------------- ### Creating Order - BigONE API - HTTP Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_orders.md Creates a new order for the authenticated user. Requires specifying the market, side (BID/ASK), price, and amount. The amount must be greater than 0. ```HTTP POST /private/orders ``` -------------------------------- ### Retrieve User Withdrawals (HTTP) Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_withdrawal.md Retrieves a collection of user withdrawal records. Requires read permission for the wallet. Optional parameters include asset, page, and per_page for filtering and pagination. ```HTTP GET /private/withdrawals ``` -------------------------------- ### Canceling Orders - BigONE API - HTTP Source: https://github.com/inblockchain/bigone-developer-api/blob/master/docs/api_orders.md Cancels one or more orders for the authenticated user. Requires a list of order IDs to be canceled. This is an asynchronous action, and the API returns a success response immediately. ```HTTP POST /private/orders/cancle ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.