Welcome to the API Documentation for our financial services platform. This document provides comprehensive details on how to interact with our API to perform a wide range of operations, including managing fiat and crypto withdrawals, retrieving requisites, handling exchanges, and more.
\nOur API uses token-based authentication to ensure secure access. Each request must include a valid token in the header. The token can be obtained through our authentication endpoint.
\nAuthenticated requests must include both APIKey and APISign HTTP header in the request payload.
To construct the signature, use the following format:
\n\"#{canonical_verb}|#{canonical_uri}|#{canonical_query}|#{access_key}\"
where:
\ncanonical_verb: HTTP request method (e.g., GET, POST, etc.)
\ncanonical_uri: request path starting from the API root URL.
\ncanonical_query: input parameters. For GET requests, these are query parameters; for POST and other methods, these are body parameters.
\naccess_key: access key associated with the API request.
\nSignature should be coded with HmacSHA256 algorithm and subscribed by secret_key
import hmac\nimport hashlib\nimport requests\nfrom urllib.parse import urlencode\n# Configuration variables\nhttp_method = \"POST\" # or \"POST\", \"PUT\", etc.\ncanonical_uri = \"/api/v2/deposit_addresses\" # example endpoint path\naccess_key = \"tGhT343HpEYExsGzJ4qNbMLTTFAwTy3OKd2WGIxc\"\nsecret_key = \"SB9S1L3IO4EHs9xQvsQFnhxnDwiWSzabGLiNNdGr\"\n# Function to flatten an object (to be used for POST/PUT/PATCH/DELETE requests)\ndef flatten_object(obj, parent_key='', res={}):\n for key in obj:\n prop_name = f\"{parent_key}_{key}\" if parent_key else key\n if isinstance(obj[key], dict):\n flatten_object(obj[key], prop_name, res)\n else:\n res[prop_name] = obj[key]\n return res\n# Function to convert object to query string\ndef object_to_query_string(obj):\n flat_object = flatten_object(obj)\n sorted_keys = sorted(flat_object.keys())\n query_params = [\n f\"{key}={flat_object[key]}\" for key in sorted_keys\n ]\n return '&'.join(query_params)\n# Prepare the message to sign based on HTTP method\nif http_method == \"GET\":\n # For GET request, use query parameters from the URL (if any)\n query_params = {\n \"amount\": \"0.05\",\n \"input_asset\": \"btc\",\n \"output_asset\": \"xrp\"\n }\n canonical_query = object_to_query_string(query_params)\n canonical_string = f\"{http_method}|{canonical_uri}|{canonical_query}\"\nelif http_method in [\"POST\", \"PUT\", \"PATCH\", \"DELETE\"]:\n # For POST/PUT/PATCH/DELETE requests, use the body of the request\n request_body = {\n \"dchain\": \"usdc\"\n }\n canonical_query = object_to_query_string(request_body)\n canonical_string = f\"{http_method}|{canonical_uri}|{canonical_query}\"\n# Generate the HMAC SHA256 signature\nsignature = hmac.new(\n secret_key.encode('utf-8'),\n canonical_string.encode('utf-8'),\n hashlib.sha256\n).hexdigest()\n# Prepare the headers\nheaders = {\n \"accept\": 'application/json',\n \"APIKey\": access_key,\n \"APISign\": signature\n}\n# Define the full URL (assuming 'https://api.example.com' is the base URL)\nurl = \"https://api.novabtc.io\" + canonical_uri\n# Send the GET or POST request\nif http_method == \"GET\":\n response = requests.get(url, headers=headers, params=query_params) # Use params for GET requests\nelse:\n response = requests.request(\n http_method,\n url,\n headers=headers,\n json=request_body\n ) # Use json for POST/PUT/PATCH/DELETE\n# Check the response\nprint(response.status_code)\nprint(response.text)\n\nUpdates on system objects can be received through a WebSocket connection.
\nWebSocket URL: wss://api.novabtc.io
\nSocketIO Path: /zsu/ws/v1
To connect, you need to use api_key, api_secret (which can be obtained when generating a token in your account api_keys page), user_uuid (which can be obtained by requesting /api/v2/members/me as the uuid attribute), and api_sign - this is an HMAC signature created based on canonicalString. More details in the example.
Here is an example of connecting to the WebSocket server in Python using the python-socketio[client] library:
import socketio\nimport hmac\nimport hashlib\nSERVER_URL = 'wss://api.novabtc.io'\nAPI_KEY = 'kjdh723ncs73ncdsnc72ncs73kds32L3skD2'\nAPI_SECRET = 'GJSsaK3PpwOjgLK2lkPmQ5TZRtF2pPoQBZ9yyuAa'\nUSER_UUID = 'novabtcz1agv'\ndef generate_hmac(canonical_string: str, secret: str) -> str:\n return hmac.new(secret.encode(), canonical_string.encode(), hashlib.sha256).hexdigest()\ncanonical_string = f'{USER_UUID}|{API_KEY}'\napi_sign = generate_hmac(canonical_string, API_SECRET)\nsio = socketio.Client()\n@sio.event\ndef connect():\n print(f'Connected to: {SERVER_URL}')\n print(f'With this api_key: {API_KEY}')\n@sio.event\ndef disconnect():\n print('Disconnected')\n@sio.event\ndef close(data):\n print(f'Connection closed: {data}')\n@sio.event\ndef connect_error(data):\n print(f'Connection error: {data}')\n@sio.on('account')\ndef on_account(data):\n print('Message from server (account):', data)\n@sio.on('deposit_address')\ndef on_deposit_address(data):\n print('Message from server (deposit_address):', data)\n@sio.on('deposit')\ndef on_deposit(data):\n print('Message from server (deposit):', data)\n@sio.on('withdrawal')\ndef on_withdrawal(data):\n print('Message from server (withdrawal):', data)\nurl = f\"{SERVER_URL}?api_key={API_KEY}&api_sign={api_sign}\"\nsio.connect(url, transports=['websocket'], socketio_path='/zsu/ws/v1')\nsio.wait()\n\ncustomer
\ndeposit
\norder
\nwithdrawal
\ntrade
\ndeposit_address
\naccount
\nExample data for the account object received from the server:
{\n \"version\": \"1\",\n \"action\": \"update\",\n \"object\": {\n \"aml_locked\": \"0.0\",\n \"balance\": \"0.0\",\n \"bonus\": \"0.0\",\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": \"0.0\",\n \"locked\": \"0.0\",\n \"name\": \"Tether USD\",\n \"savings\": \"0.0\",\n \"stacking\": \"0.0\",\n \"tag\": null,\n \"total\": \"0.0\"\n }\n}\n\nThis example demonstrates how a client can connect to the WebSocket server and process the messages received from it. Use the appropriate api_key, api_secret, and user_uuid for your connection.
Creates a new deposit address on a specific blockchain network.
\ndchainThe dchain should be taken from the GET /api/v2/assets endpoint response:
{\n \"items\": [\n {\n \"asset_id\": \"usdt\", // USDT as an example\n \"dchains\": [\n {\n \"display_name\": \"TRC20\",\n \"dchain_id\": \"trc20usdt\" // <--- Use this value as the dchain parameter\n }\n ]\n },\n ...\n ]\n}\n\n