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 is designed to provide secure, efficient, and easy-to-use access to our platform's capabilities. It supports various operations crucial for integrating financial services into your applications. This includes endpoints for creating and managing withdrawals, listing and filtering requisites, handling currency exchanges, and estimating exchange rates.
\nRequests to our API should be made using standard HTTP methods, such as GET, POST, and DELETE. Each endpoint details the required method, parameters, and possible responses.
Our API responses are formatted in JSON, providing a clear and consistent structure for handling data. Each endpoint's documentation includes examples of successful responses and potential error messages.
\nIn case of errors, the API will return appropriate HTTP status codes along with a message describing the error. Common error codes include:
\n400 Bad Request: The request was invalid or cannot be served.
401 Unauthorized: Authentication failed or user does not have permissions for the desired action.
404 Not Found: The requested resource could not be found.
500 Internal Server Error: An error occurred on the server.
Authenticated requests must include a digital signature generated with the HMAC-SHA256 algorithm.
\nSignature Overview
\nThe signature is generated from the canonical message:
\n{HTTP_METHOD}|{REQUEST_PATH}|{DATA_TO_SIGN}\n\nHTTP_METHOD — the HTTP method used (GET, POST, PUT, DELETE, etc.)
REQUEST_PATH — the endpoint path starting from the API root (for example /api/v1/order)
DATA_TO_SIGN — serialized request parameters, built according to the rules below
\nDATA_TO_SIGN:GET requests:Include all query parameters except access_key, nonce, and empty values.
Decode parameter names and values.
\nGroup parameters by name and sort alphabetically.
\nIf duplicate keys exist, join their values with commas.
\nkey1=value1&key2=value2,value3
\nPOST, PUT, PATCH, DELETE requests:Flatten the JSON body into key–value pairs.
\nNested objects use underscore notation: parent_child=value.
Arrays are converted to comma-separated strings.
\nExclude empty or null values.
\nSort keys alphabetically and join them with &.
key1=value1&key2=value2&key3=value3
\nThe signature is generated using the HMAC-SHA256 algorithm with your private key.
\nsignature = HMAC_SHA256(message, secret_key)\n\nwheremessage = {method}|{path}|{dataToSign}
The result must be a lowercase hex-encoded string.
It must be passed in the apisign HTTP header.
apisign — required. Contains the generated HMAC-SHA256 signature.
\napikey — optional. Added automatically if the variable access_key exists in the client environment. Not used in signature calculation.
Below is the complete working example used to automatically generate the signature and add the headers before sending a request:
\nconsole.log('start');\n// === common variables ===\nconst secretKey = pm.collectionVariables.get('secret_key');\nconst method = pm.request.method;\nconst endpoint = pm.request.url.getPath();\nlet dataToSign = '';\n/**\n * Groups key-value pairs, keeping array indexes [0], [1], [] \n * and preserving their original order\n */\nfunction groupPairsWithIndex(pairs) {\n const grouped = {};\n for (const [k, v, idx, order] of pairs) {\n if (!grouped[k]) grouped[k] = [];\n grouped[k].push({ v, idx, order });\n }\n const keys = Object.keys(grouped).sort();\n const parts = [];\n for (const k of keys) {\n const items = grouped[k];\n const hasIndex = items.some(it => Number.isInteger(it.idx));\n const sorted = hasIndex\n ? items\n .map(it => ({\n ...it,\n idx: Number.isInteger(it.idx) ? it.idx : Number.MAX_SAFE_INTEGER,\n }))\n .sort((a, b) => a.idx - b.idx || a.order - b.order)\n : items.sort((a, b) => a.order - b.order);\n const joined = sorted.map(it => it.v).join(',');\n parts.push(`${k}=${joined}`);\n }\n return parts.join('&');\n}\n// flatten JSON body \n// (objects → key_subkey; arrays → comma-joined string)\nfunction flattenObject(obj, parentKey = '', res = {}) {\n for (const key of Object.keys(obj || {})) {\n const prop = parentKey ? `${parentKey}_${key}` : key;\n const val = obj[key];\n if (val === null || val === undefined) continue;\n if (Array.isArray(val)) {\n const joined = val.map(v => String(v).trim()).filter(Boolean).join(',');\n res[prop] = joined;\n } else if (typeof val === 'object') {\n flattenObject(val, prop, res);\n } else {\n const s = typeof val === 'string' ? val.trim() : String(val);\n if (s.length > 0) res[prop] = s;\n }\n }\n return res;\n}\n// === build dataToSign ===\nif (method === 'GET') {\n const qs = pm.request.url.getQueryString({ ignoreDisabled: true, encode: false }) || '';\n let order = 0;\n const pairs = qs\n .split('&')\n .filter(Boolean)\n .map(s => {\n const eq = s.indexOf('=');\n const rawK = eq >= 0 ? s.slice(0, eq) : s;\n const rawV = eq >= 0 ? s.slice(eq + 1) : '';\n let k = decodeURIComponent(rawK);\n const v = decodeURIComponent(rawV);\n // skip unnecessary params\n if (k === 'access_key' || k === 'nonce' || v === '' || v == null) return null;\n let idx = null;\n const m = k.match(/^(.+)\\[(\\d*)\\]$/);\n if (m) {\n k = m[1];\n idx = m[2] === '' ? null : Number(m[2]);\n } else if (/\\[\\]$/.test(k)) {\n k = k.replace(/\\[\\]$/, '');\n idx = null;\n }\n return [k, v, idx, order++];\n })\n .filter(Boolean);\n dataToSign = groupPairsWithIndex(pairs);\n console.log('qs', qs);\n console.log(['dataToSign GET', dataToSign]);\n} else if (['POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {\n let raw = '{}';\n try { raw = pm.request.body?.raw ?? '{}'; } catch (_) {}\n let body;\n try { body = JSON.parse(raw || '{}'); } catch (_) { body = {}; }\n const flat = flattenObject(body);\n const keys = Object.keys(flat).sort();\n dataToSign = keys.map(k => `${k}=${flat[k]}`).join('&');\n console.log(['dataToSign POST/...', dataToSign]);\n} else {\n dataToSign = '';\n}\n// === final message for signing ===\nconst message = `${method}|${endpoint}|${dataToSign}`;\nconst signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);\n// === set signature ===\npm.collectionVariables.set('signature', signature);\npm.request.headers.upsert({ key: 'apisign', value: signature });\n// (optional) if apikey is stored in the collection\nconst apiKey = pm.collectionVariables.get('access_key');\nif (apiKey) pm.request.headers.upsert({ key: 'apikey', value: apiKey });\nconsole.log(['message', message]);\nconsole.log(['signature', signature]);\n\napisign must be included in every authenticated request.
apikey may be included automatically if defined in the environment (optional).
Empty or null parameters are skipped.
\nArrays are comma-joined; nested objects use underscore (_).
The signature is based only on {HTTP_METHOD}|{REQUEST_PATH}|{DATA_TO_SIGN}.
Header names are case-insensitive.
\nThe WebSocket provides real-time updates for system objects such as accounts, deposits, withdrawals, trades, and orders.
\nThe platform uses socket.io (engine.io) as the transport layer, which requires a specific handshake flow.
\nDirect (“raw”) WebSocket connections are not supported.
\nAll communication is event-driven.
\nAfter connecting, the server initiates an authentication sequence, and real-time events begin only after successful authorization.
\nWebSocket URL:
\nwss://my.kyrrex.mt\n\nPath:
\n/zsu/ws/v1\n\nThe connection must be made using socket.io with this URL and path combination.
\nTo establish and authorize a WebSocket session, the following values are required:
\napi_key — public API key
\napi_secret — secret key for signature generation
\nuser_uuid — unique identifier of the user
\nThese values must be included in both the initial connection query and in the authorization event.
\nBefore connecting, a signature must be created.
\nCanonical string:
\n{user_uuid}|{api_key}\n\nSignature:
\nAlgorithm: HMAC-SHA256
\nKey: api_secret
Output: lowercase hex string
\nThis signing approach is specific to the WebSocket API.
\nTo ensure a valid engine.io handshake:
\nThe initial transport must be polling
\nThe upgrade to WebSocket is handled internally by engine.io
\nThe correct socket.io path must be used
\nAuthentication parameters must be included in the query
\nDirect WebSocket transport must not be forced
\nThe handshake sequence:
\npolling → sid assigned → websocket probe → upgrade → active session\n\nSkipping the polling phase may lead to an HTTP 200 response instead of a WebSocket upgrade.
\nAuthentication is event-based and must follow this sequence:
\nClient connects to wss://my.kyrrex.mt with the correct path and query
auth_required
\nauthorize containing:
\napi_key
\nuser_uuid
\napi_sign
\nServer responds with either:
\nauthorized
authorization_failed
Only after receiving authorized will real-time updates be delivered.
// ws.js\nconst { io } = require('socket.io-client');\nconst crypto = require('crypto');\n// ================== Config ==================\nconst SERVER_URL = 'wss://my.kyrrex.mt';\nconst api_key = 'Public Key';\nconst api_secret = 'Secret Key';\nconst user_uuid = 'UID';\nconst canonicalString = `${user_uuid}|${api_key}`;\nfunction generateHmac(str, secret) {\n return crypto.createHmac('sha256', secret).update(str).digest('hex');\n}\n// ================== Connection ==================\nconst socket = io(SERVER_URL, {\n path: '/zsu/ws/v1',\n query: {\n api_key,\n api_sign: generateHmac(canonicalString, api_secret),\n user_uuid,\n },\n withCredentials: true,\n transports: ['polling'],\n upgrade: false,\n reconnection: true,\n reconnectionAttempts: Infinity,\n reconnectionDelay: 3000,\n reconnectionDelayMax: 10000,\n randomizationFactor: 0.5,\n});\n// ================== Handlers ==================\nsocket.on('connect', () => {\n console.log('CONNECTED');\n console.log('id:', socket.id);\n});\nsocket.on('auth_required', (payload) => {\n console.log('[auth_required]:', payload);\n const authPayload = {\n api_key,\n api_sign: generateHmac(canonicalString, api_secret),\n user_uuid,\n };\n console.log('sending authorize', authPayload);\n socket.emit('authorize', authPayload);\n});\nsocket.on('authorized', (data) => {\n console.log('AUTHORIZED:', data);\n});\nsocket.on('authorization_failed', (err) => {\n console.log('AUTH FAILED:', err);\n});\nsocket.on('disconnect', (reason) => {\n console.log('DISCONNECTED:', reason);\n});\nsocket.on('connect_error', (err) => {\n console.log('CONNECT_ERROR:', err.message);\n console.dir(err, { depth: 3 });\n});\nsocket.on('error', (err) => {\n console.log('ERROR:', err);\n});\n// Events\nsocket.on('account', (msg) => {\n console.log('[account]:', msg);\n});\nsocket.on('deposit_address', (msg) => {\n console.log('[deposit_address]:', msg);\n});\n// Other\nsocket.onAny((event, data) => {\n console.log(`[${event}]`, data);\n});\n\nAfter the session is authorized, the following events may be emitted:
\naccount
deposit
withdrawal
order
trade
deposit_address
customer
Each event delivers an updated object.
\nExample update for the account event:
\n{\n \"data\": {\n \"version\": \"1\",\n \"action\": \"update\",\n \"object\": {\n \"aml_locked\": \"0.0\",\n \"balance\": \"82.9858332031\"\n }\n }\n}\n\nOnly socket.io connections are supported
\nThe initial handshake must use polling transport
\nAuthorization must occur before receiving updates
\nThe signature and parameters must follow the described format
\nThe provided script represents the expected integration pattern
\nThis endpoint retrieves the information of the currently authenticated member.
\nGET /api/v2/members/me
activated (boolean): Indicates if the member is activated.
average_holding (number): The average holding value.
banned (boolean): Indicates if the member is banned.
email (string): The email address of the member.
fee_grid_id (number): The fee grid ID.
fee_grid_note (object): Details of the fee grid note.
id (number): The ID of the fee grid note.
market_id (string): The market ID.
name (string): The name of the fee grid note.
stacking (number): The stacking value.
volume (number): The volume value.
fee_taker (number): The fee for taker.
fee_maker (number): The fee for maker.
fee_fiat_system (number): The fiat system fee.
fee_fiat_exchange (number): The fiat exchange fee.
fee_fiat_provider (number): The fiat provider fee.
created_at (string): The date and time of creation.
updated_at (string): The date and time of last update.
trading_volume (number): The trading volume.
uuid (string): The UUID of the member.
verified (boolean): Indicates if the member is verified.
{\n \"activated\": true,\n \"average_holding\": 0,\n \"banned\": true,\n \"email\": \"\",\n \"fee_grid_id\": 0,\n \"fee_grid_note\": {\n \"id\": 0,\n \"market_id\": \"\",\n \"name\": \"\",\n \"stacking\": 0,\n \"volume\": 0,\n \"fee_taker\": 0,\n \"fee_maker\": 0,\n \"fee_fiat_system\": 0,\n \"fee_fiat_exchange\": 0,\n \"fee_fiat_provider\": 0,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"trading_volume\": 0,\n \"uuid\": \"\",\n \"verified\": true\n}\n\nThis endpoint retrieves the total balance of the members in various assets, including cryptocurrencies and fiat, with the balance output in the specified asset.
\nMethod: GET
\nEndpoint: https://my.kyrrex.mt/api/v2/members/total_balance
Query Parameters:
\noutput_asset (string, required): The asset in which the total balance should be output. Example: eur.Upon a successful request, the response will include the total balance and account details in various assets, including cryptocurrencies and fiat. The response will be in the following format:
\n{\n \"output_asset\": \"\",\n \"total\": \"\",\n \"accounts\": {\n \"xrp\": \"\",\n \"xlm\": \"\",\n \"eth\": \"\",\n \"ltc\": \"\",\n \"bch\": \"\",\n \"trx\": \"\",\n \"btc\": \"\",\n \"eur\": \"\",\n \"usdt\": \"\"\n },\n \"crypto\": {\n \"total\": \"\",\n \"accounts\": {\n \"xrp\": \"\",\n \"xlm\": \"\",\n \"eth\": \"\",\n \"ltc\": \"\",\n \"bch\": \"\",\n \"trx\": \"\",\n \"btc\": \"\",\n \"usdt\": \"\"\n }\n },\n \"fiat\": {\n \"total\": \"\",\n \"accounts\": {\n \"eur\": \"\"\n }\n },\n \"udr\": {\n \"total\": \"\",\n \"accounts\": {}\n }\n}\n\nAsset against which all balances will be calculated
\n","type":"text/plain"},"key":"output_asset","value":"eur"}],"variable":[]}},"response":[{"id":"27cbbd3a-bfd4-4ec3-894c-eaebe8e8d709","name":"Retrieves total balances for the authenticated member","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://kyrrex.mt/api/v2/members/total_balance?output_asset=eur","protocol":"https","host":["kyrrex","mt"],"path":["api","v2","members","total_balance"],"query":[{"key":"output_asset","value":"eur","description":"Asset against which all balances will be calculated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"output_asset\": \"eur\",\n \"total\": \"4438.83\",\n \"accounts\": {\n \"xrp\": \"235.0950789903159103\",\n \"xlm\": \"0.0750362495041061\",\n \"eth\": \"3193.73\",\n \"ltc\": \"0.0\",\n \"bch\": \"13.6653525787875554\",\n \"trx\": \"81.7213782040986528\",\n \"btc\": \"82.6923843934999999\",\n \"eur\": \"41.55\",\n \"usdt\": \"790.3031303915326683\"\n },\n \"crypto\": {\n \"total\": \"4397.28\",\n \"accounts\": {\n \"xrp\": \"235.0950789903159103\",\n \"xlm\": \"0.0750362495041061\",\n \"eth\": \"3193.73\",\n \"ltc\": \"0.0\",\n \"bch\": \"13.6653525787875554\",\n \"trx\": \"81.7213782040986528\",\n \"btc\": \"82.6923843934999999\",\n \"usdt\": \"790.3031303915326683\"\n }\n },\n \"fiat\": {\n \"total\": \"41.55\",\n \"accounts\": {\n \"eur\": \"41.55\"\n }\n },\n \"udr\": {\n \"total\": \"0.0\",\n \"accounts\": {}\n }\n}"}],"_postman_id":"79094856-97aa-4542-af02-6e6956c74444"},{"name":"Retrieves a list of accounts for the authenticated member","id":"40df52d0-831b-440e-adb5-b58c2ac89800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/members/accounts?only_positive_accounts=true&tags","description":"This endpoint retrieves a list of member accounts with the option to filter for only positive accounts and tags.
\nRequest
\nMethod: GET
\nURL: https://my.kyrrex.mt/api/v2/members/accounts
Query Parameters:
\nonly_positive_accounts: true (boolean)
\ntags: (string)
\nResponse
The response will include a JSON object with the following structure:
{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": \"\",\n \"total\": 0\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": \"\",\n \"total\": 0\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": \"\",\n \"total\": 0\n }\n ],\n \"udr\": []\n }\n}\n\nFilter accounts with nonzero balance
\n","type":"text/plain"},"key":"only_positive_accounts","value":"true"},{"description":{"content":"Filter accounts by tags
\n","type":"text/plain"},"key":"tags","value":null}],"variable":[]}},"response":[{"id":"692ddb3a-3c20-461b-8bfc-4512dd6eb648","name":"Retrieves a list of accounts for the authenticated member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://kyrrex.mt/api/v2/members/accounts?only_positive_accounts=true&tags","protocol":"https","host":["kyrrex","mt"],"path":["api","v2","members","accounts"],"query":[{"key":"only_positive_accounts","value":"true","description":"Filter accounts with nonzero balance"},{"key":"tags","value":null,"description":"Filter accounts by tags"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 9,\n \"per_page\": 10,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 41.55\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 849.0260299\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 849.0260299\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 41.55\n }\n ],\n \"udr\": []\n }\n}"}],"_postman_id":"40df52d0-831b-440e-adb5-b58c2ac89800"}],"id":"d26e75c3-028d-4392-8460-1ba2ca53e0f2","_postman_id":"d26e75c3-028d-4392-8460-1ba2ca53e0f2","description":""},{"name":"Assets","item":[{"name":"Retrieves a list of assets with optional filters","id":"48f5f5b1-261a-4a05-9cf4-9f24ed65626a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/assets?page=integer&per_page=integer&active_deposit=boolean&active_withdrawal=boolean","description":"This endpoint retrieves a list of assets with optional pagination and filtering options.
\nMethod: GET
\nURL: https://my.kyrrex.mt/api/v2/assets
Query Parameters:
\npage (integer, required): The page number for pagination.
per_page (integer, required): The number of assets to be included per page.
active_deposit (boolean, optional): Filter by active deposit status.
active_withdrawal (boolean, optional): Filter by active withdrawal status.
The response will include the total count of assets, pagination details, and a list of asset items. Each asset item contains information such as balance, bonus, coin type, currency, and more. Additionally, the response includes account details for crypto, fiat, and UDR (User Defined Resources).
\nExample Response:
\n{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"udr\": []\n }\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":"integer"},{"description":{"content":"Filter assets with active deposits
\n","type":"text/plain"},"key":"active_deposit","value":"boolean"},{"description":{"content":"Filter assets with active withdrawals
\n","type":"text/plain"},"key":"active_withdrawal","value":"boolean"}],"variable":[]}},"response":[{"id":"5aa7154d-9990-484a-a2cc-16b528c08708","name":"Retrieves a list of assets with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://kyrrex.mt/api/v2/assets?page=integer&per_page=integer&active_deposit=boolean&active_withdrawal=boolean","protocol":"https","host":["kyrrex","mt"],"path":["api","v2","assets"],"query":[{"key":"page","value":"integer","description":"Pagination page number"},{"key":"per_page","value":"integer","description":"Number of items per page"},{"key":"active_deposit","value":"boolean","description":"Filter assets with active deposits"},{"key":"active_withdrawal","value":"boolean","description":"Filter assets with active withdrawals"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 9,\n \"per_page\": 10,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 41.55\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 849.0260299\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 849.0260299\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 41.55\n }\n ],\n \"udr\": []\n }\n}"}],"_postman_id":"48f5f5b1-261a-4a05-9cf4-9f24ed65626a"},{"name":"Retrieves information about a specific asset","id":"fc345dc5-a501-466f-85a2-7b7047522f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/assets/{code}","description":"This endpoint retrieves the details of a specific asset identified by its code.
\nMethod: GET
\nURL: https://my.kyrrex.mt/api/v2/assets/{code}
The response will include the details of the asset, such as its ID, name, precision, type, and the associated dchains. Each dchain contains information about its active status, AML (Anti-Money Laundering) status, confirmations for deposit and withdrawal, contact AML, contract address, digit, display name, data type, minimum deposit and withdrawal amounts, and tag visibility.
\nExample response:
\n{\n \"asset_id\": \"\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset_id\": \"\",\n \"chain\": null,\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": null,\n \"contract_address\": null,\n \"dchain_id\": \"\",\n \"digit\": 0,\n \"display_name\": \"\",\n \"dtype\": \"\",\n \"min_deposit\": 0,\n \"min_withdrawal\": 0,\n \"tag\": null,\n \"tag_require\": true,\n \"tag_visible\": true\n }\n ],\n \"name\": \"\",\n \"precision\": 0,\n \"tag\": null,\n \"type\": \"\"\n}\n\nThis endpoint retrieves a list of markets based on the provided query parameters.
\npage (optional): The page number for paginated results.
per_page (optional): The number of items to be included per page.
active (optional): Filter by market activity status.
asset (optional): Filter by asset.
base_asset (optional): Filter by base asset.
quote_asset (optional): Filter by quote asset.
type (optional): Filter by market type.
tags (optional): Filter by market tags.
The response will include:
\ntotal_count: The total count of markets.
per_page: The number of items per page.
total_pages: The total number of pages.
page: The current page number.
prev_page: The previous page number, if available.
next_page: The next page number, if available.
items: An array of market items, each containing:
active: The activity status of the market.
available_quote_balance: The available quote balance.
base_asset: The base asset of the market.
base_asset_tag: The tag associated with the base asset.
base_precision: The precision of the base asset.
id: The market ID.
market: The market name.
name: The market name.
quote_asset: The quote asset of the market.
quote_asset_tag: The tag associated with the quote asset.
quote_precision: The precision of the quote asset.
Pagination page number
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"Filter only active markets
\n","type":"text/plain"},"key":"active","value":null},{"description":{"content":"Mutually exclusive with base_asset and quote_asset. Filters markets including the specified asset as either base or quote currency.
\n","type":"text/plain"},"key":"asset","value":null},{"description":{"content":"Filters markets including the specified asset as the base currency.
\n","type":"text/plain"},"key":"base_asset","value":null},{"description":{"content":"Filters markets including the specified asset as the quote currency.
\n","type":"text/plain"},"key":"quote_asset","value":null},{"description":{"content":"Filters markets by asset type (crypto, fiat).
\n","type":"text/plain"},"key":"type","value":null},{"description":{"content":"Filters markets by tags
\n","type":"text/plain"},"key":"tags","value":null}],"variable":[]}},"response":[{"id":"02f8f226-c143-4cc7-91c9-379860764dae","name":"Retrieves a list of markets","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 18,\n \"per_page\": 2,\n \"total_pages\": 9,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"usdt\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"usdteur\",\n \"market\": \"usdteur\",\n \"name\": \"USDT/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 4\n },\n {\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"trx\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"trxeur\",\n \"market\": \"trxeur\",\n \"name\": \"TRX/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 6\n }\n ]\n}"}],"_postman_id":"181ec4e5-fd34-4c7d-bc1f-b691d13bcd4a"},{"name":"Retrieves information about a specific market","id":"3646783a-b1e7-4466-b229-7bf88703907b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/markets/info?market","description":"The GET /markets/info endpoint retrieves information about a specific market. The request does not require any specific parameters, and it returns details about the market such as its active status, available quote balance, base asset, base asset tag, base precision, market ID, market name, quote asset, quote asset tag, and quote precision.
This request does not require a request body.
\nactive (boolean): Indicates whether the market is active.
available_quote_balance (number): The available balance of the quote asset.
base_asset (string): The base asset of the market.
base_asset_tag (string, optional): The tag associated with the base asset.
base_precision (number): The precision of the base asset.
id (string): The unique identifier of the market.
market (string): The market symbol.
name (string): The name of the market.
quote_asset (string): The quote asset of the market.
quote_asset_tag (string, optional): The tag associated with the quote asset.
quote_precision (number): The precision of the quote asset.
Market identifier
\n","type":"text/plain"},"key":"market","value":null}],"variable":[]}},"response":[{"id":"ac5c4fd2-3227-42ab-b08a-0e02aad9e554","name":"Retrieves information about a specific market","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/markets/info?market","host":["https://my.kyrrex.mt/api"],"path":["v2","markets","info"],"query":[{"key":"market","value":null,"description":"Market identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"trx\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"trxeur\",\n \"market\": \"trxeur\",\n \"name\": \"TRX/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 6\n}"}],"_postman_id":"3646783a-b1e7-4466-b229-7bf88703907b"}],"id":"a310600b-b3aa-4d1d-918c-889dd39b0ea3","_postman_id":"a310600b-b3aa-4d1d-918c-889dd39b0ea3","description":""},{"name":"Deposit addresses","item":[{"name":"Retrieves a list of deposit addresses","id":"18e848ed-15fb-4cbd-b614-e0910c3c7a3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/deposit_addresses?page&per_page&dchains&gateway","description":"This endpoint retrieves deposit addresses with optional pagination and filtering.
\nMethod: GET
\nURL: https://my.kyrrex.mt/api/v2/deposit_addresses
Query Parameters:
\npage (optional): The page number for pagination.
\nper_page (optional): The number of items per page.
\ndchains (optional): Filter by specific dchains.
\ngateway (optional): Filter by gateway.
\nThe response will be a JSON object with the following schema:
\n{\n \"limit\": integer,\n \"total_count\": integer,\n \"per_page\": integer,\n \"total_pages\": integer,\n \"page\": integer,\n \"prev_page\": null or integer,\n \"next_page\": null or integer,\n \"items\": [\n {\n \"address\": string,\n \"asset\": string,\n \"dchain\": string,\n \"expired_at\": null or string,\n \"name\": null or string,\n \"tag\": null or string,\n \"type\": string,\n \"uuid\": integer\n }\n ]\n}\n\nThe items array contains deposit address objects with details such as address, asset, dchain, expired_at, name, tag, type, and uuid.
Pagination page number
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"Filters addresses by blockchain identifiers
\n","type":"text/plain"},"key":"dchains","value":null},{"description":{"content":"Filters addresses by gateway
\n","type":"text/plain"},"key":"gateway","value":null}],"variable":[]}},"response":[{"id":"631d2cbc-a053-4c09-90e0-17611c5fe30c","name":"Retrieves a list of deposit addresses","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/deposit_addresses?page&per_page&dchains&gateway","host":["https://my.kyrrex.mt/api"],"path":["v2","deposit_addresses"],"query":[{"key":"page","value":null,"description":"Pagination page number"},{"key":"per_page","value":null,"description":"Number of items per page"},{"key":"dchains","value":null,"description":"Filters addresses by blockchain identifiers"},{"key":"gateway","value":null,"description":"Filters addresses by gateway"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 7,\n \"total_count\": 1,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"TQrqHrKwZ99GDbec7u77JH85k2e7gYixYo\",\n \"asset\": \"usdt\",\n \"dchain\": \"trc20usdt\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"crypto_address\",\n \"uuid\": 2174\n }\n ]\n}"}],"_postman_id":"18e848ed-15fb-4cbd-b614-e0910c3c7a3e"},{"name":"Creates a new deposit address","id":"1ab9b055-ee6f-426b-a4a7-10c088523577","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.kyrrex.mt/api/v2/deposit_addresses?dchain","description":"This endpoint allows you to create deposit addresses for a specific blockchain. The request should be sent as an HTTP POST to https://my.kyrrex.mt/api/v2/deposit_addresses?dchain.
\naddress (string): The deposit address.
asset (string): The asset for which the deposit address is being created.
dchain (string): The specific blockchain for which the deposit address is being created.
type (string): The type of the deposit address.
name (string, optional): The name of the deposit address.
tag (string, optional): The tag associated with the deposit address.
Upon successful creation, the response will include the following fields:
\naddress (string): The deposit address.
asset (string): The asset for which the deposit address is created.
dchain (string): The specific blockchain for which the deposit address is created.
expired_at (datetime): The expiration date of the deposit address.
name (string, optional): The name of the deposit address.
tag (string, optional): The tag associated with the deposit address.
type (string): The type of the deposit address.
uuid (integer): The unique identifier for the deposit address.
If the deposit address creation is unsuccessful, appropriate error responses will be returned.
\n","urlObject":{"path":["v2","deposit_addresses"],"host":["https://my.kyrrex.mt/api"],"query":[{"description":{"content":"Blockchain identifier
\n","type":"text/plain"},"key":"dchain","value":null}],"variable":[]}},"response":[{"id":"6da22e70-6bb8-4ec0-8774-ebdb21e2a837","name":"Creates a new deposit address","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/deposit_addresses?dchain","host":["https://my.kyrrex.mt/api"],"path":["v2","deposit_addresses"],"query":[{"key":"dchain","value":null,"description":"Blockchain identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"TQrqHrKwZ99GDbec7u77JH85k2e7gYixYo\",\n \"asset\": \"usdt\",\n \"dchain\": \"trc20usdt\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"crypto_address\",\n \"uuid\": 2174\n}"}],"_postman_id":"1ab9b055-ee6f-426b-a4a7-10c088523577"}],"id":"e52e7254-a637-4e64-b3fa-80b25b7b8c01","_postman_id":"e52e7254-a637-4e64-b3fa-80b25b7b8c01","description":""},{"name":"Transactions","item":[{"name":"Retrieves a list of deposit transactions","id":"cd9b26a2-1597-4c4c-900d-1896bd5303fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/transactions?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","description":"The API endpoint retrieves a list of transactions based on the provided parameters. The response is in the form of a JSON schema and includes the following fields:
\ntotal_count (number): Total count of transactions
\nper_page (number): Number of transactions per page
\ntotal_pages (number): Total number of pages
\npage (number): Current page number
\nprev_page (null or number): Previous page number or null if no previous page
\nnext_page (null or number): Next page number or null if no next page
\nitems (array): Array of transaction objects, each containing the following fields:
\naddress (string): Address associated with the transaction
\namount (number): Amount of the transaction
\nasset (string): Asset of the transaction
\nasset_type (string): Type of asset
\ncontrol (null or string): Control information
\ncreated_at (string): Timestamp of creation
\ndchain_id (string): ID in the blockchain
\ndone_at (string): Timestamp of completion
\nfee (number): Transaction fee
\nhigh_risk (null or boolean): Indicates if transaction is high risk
\nstatus (string): Status of the transaction
\ntag (null or string): Tag associated with the transaction
\ntx_id (string): Transaction ID
\ntx_link (string): Link to the transaction
\ntype (string): Type of transaction
\nupdated_at (string): Timestamp of last update
\nuuid (number): Unique identifier for the transaction
\nThe response provides a detailed schema for the transaction data, allowing for easy interpretation and consumption of the API response.
\n","urlObject":{"path":["v2","transactions"],"host":["https://my.kyrrex.mt/api"],"query":[{"description":{"content":"Pagination page number
\n","type":"text/plain"},"key":"page","value":" "},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":" "},{"description":{"content":"Filters transactions by asset
\n","type":"text/plain"},"key":"asset","value":" "},{"description":{"content":"Filters transactions by status
\n","type":"text/plain"},"key":"status","value":" "},{"description":{"content":"Filters transactions from this date
\n","type":"text/plain"},"key":"from","value":" "},{"description":{"content":"Filters transactions until this date
\n","type":"text/plain"},"key":"to","value":" "},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specific field
\n","type":"text/plain"},"key":"sort_by","value":" "}],"variable":[]}},"response":[{"id":"9e477b68-b787-4f6e-8a06-e8e0336513fb","name":"Retrieves a list of deposit transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/transactions?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","host":["https://my.kyrrex.mt/api"],"path":["v2","transactions"],"query":[{"key":"page","value":" ","description":"Pagination page number"},{"key":"per_page","value":" ","description":"Number of items per page"},{"key":"asset","value":" ","description":"Filters transactions by asset"},{"key":"status","value":" ","description":"Filters transactions by status"},{"key":"from","value":" ","description":"Filters transactions from this date"},{"key":"to","value":" ","description":"Filters transactions until this date"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":" ","description":"Sort by specific field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 37,\n \"per_page\": 2,\n \"total_pages\": 19,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"address\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\",\n \"amount\": 100.0,\n \"asset\": \"trx\",\n \"asset_type\": \"crypto\",\n \"control\": null,\n \"created_at\": \"2023-05-08T14:02:06.213Z\",\n \"dchain_id\": \"trx\",\n \"done_at\": \"2023-05-08T14:02:16.088Z\",\n \"fee\": 0.0,\n \"high_risk\": null,\n \"status\": \"blocked_limit_exceeded\",\n \"tag\": null,\n \"tx_id\": \"23d01ab620a2a56ec78a31b35647adea8afeb95e89eeedc33c98270700c0ba2c\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/23d01ab620a2a56ec78a31b35647adea8afeb95e89eeedc33c98270700c0ba2c\",\n \"type\": \"deposit\",\n \"updated_at\": \"2023-05-08T14:02:16.088Z\",\n \"uuid\": 149697474\n },\n {\n \"address\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\",\n \"amount\": 101.0,\n \"asset\": \"trx\",\n \"asset_type\": \"crypto\",\n \"control\": null,\n \"created_at\": \"2023-05-08T14:18:04.268Z\",\n \"dchain_id\": \"trx\",\n \"done_at\": \"2023-05-08T14:18:12.207Z\",\n \"fee\": 0.0,\n \"high_risk\": null,\n \"status\": \"blocked_limit_exceeded\",\n \"tag\": null,\n \"tx_id\": \"848150859adb64d396e72869c7a7d6edf3c87e8bcee1492b6c58ee2214438bfe\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/848150859adb64d396e72869c7a7d6edf3c87e8bcee1492b6c58ee2214438bfe\",\n \"type\": \"deposit\",\n \"updated_at\": \"2023-05-08T14:18:12.207Z\",\n \"uuid\": 386122122\n }\n ]\n}"}],"_postman_id":"cd9b26a2-1597-4c4c-900d-1896bd5303fc"},{"name":"Retrieves a list of withdrawal transactions","id":"85db603a-db81-42ed-be86-a253e2db1878","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/transactions/withdrawals?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","description":"This endpoint retrieves a list of withdrawal transactions based on the provided query parameters. The query parameters include pagination (page and per_page), asset type, status, date range (from and to), and sorting options (sort and sort_by).
\nThis request does not require a request body.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"total_count\": {\n \"type\": \"integer\"\n },\n \"per_page\": {\n \"type\": \"integer\"\n },\n \"total_pages\": {\n \"type\": \"integer\"\n },\n \"page\": {\n \"type\": \"integer\"\n },\n \"prev_page\": {\n \"type\": [\"integer\", \"null\"]\n },\n \"next_page\": {\n \"type\": [\"integer\", \"null\"]\n },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": {\n \"type\": \"string\"\n },\n \"amount\": {\n \"type\": \"number\"\n },\n \"asset\": {\n \"type\": \"string\"\n },\n \"asset_type\": {\n \"type\": \"string\"\n },\n \"control\": {\n \"type\": \"boolean\"\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"dchain_id\": {\n \"type\": \"string\"\n },\n \"done_at\": {\n \"type\": \"string\"\n },\n \"fee\": {\n \"type\": \"number\"\n },\n \"high_risk\": {\n \"type\": \"boolean\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": [\"string\", \"null\"]\n },\n \"tx_id\": {\n \"type\": \"string\"\n },\n \"tx_link\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"type\": \"string\"\n },\n \"uuid\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"address\",\n \"amount\",\n \"asset\",\n \"asset_type\",\n \"control\",\n \"created_at\",\n \"dchain_id\",\n \"done_at\",\n \"fee\",\n \"high_risk\",\n \"status\",\n \"tx_id\",\n \"tx_link\",\n \"type\",\n \"updated_at\",\n \"uuid\"\n ]\n }\n }\n },\n \"required\": [\n \"total_count\",\n \"per_page\",\n \"total_pages\",\n \"page\",\n \"prev_page\",\n \"next_page\",\n \"items\"\n ]\n}\n\nThis request does not require a request body.
\nThe response will include an array of withdrawal transactions, each containing details such as:
\naddress (string): The withdrawal address
amount (number): The amount of the withdrawal
asset (string): The type of asset
asset_type (string): The type of the asset
control (boolean): Indicates if the withdrawal is under control
created_at (string): The creation timestamp of the withdrawal
dchain_id (string): The ID of the withdrawal in the chain
done_at (string): The completion timestamp of the withdrawal
fee (number): The fee associated with the withdrawal
high_risk (boolean): Indicates if the withdrawal is considered high risk
status (string): The status of the withdrawal
tag (string): The tag associated with the withdrawal
tx_id (string): The transaction ID of the withdrawal
tx_link (string): The link to the transaction
type (string): The type of withdrawal
updated_at (string): The last update timestamp of the withdrawal
uuid (number): The UUID of the withdrawal
The response also includes metadata such as:
\ntotal_count (number): The total count of withdrawal transactions
per_page (number): The number of transactions per page
total_pages (number): The total number of pages
page (number): The current page
prev_page (number/null): The previous page number, or null if there is no previous page
next_page (number/null): The next page number, or null if there is no next page
This endpoint allows you to initiate a fiat withdrawal.
\ndchain (string): The destination chain for the withdrawal.
amount (string): The amount to be withdrawn.
payout_method (string): The method of payout, e.g., bank transfer.
instrument (string): The instrument for withdrawal, e.g., SEPA.
first_name (string): The first name of the account holder.
last_name (string): The last name of the account holder.
dob (string): The date of birth of the account holder.
country_id (integer): The ID of the country.
postcode (string): The postcode of the account holder's address.
city (string): The city of the account holder's address.
address (string): The address of the account holder.
iban (string): The IBAN of the account.
amount (number): The amount of the withdrawal.
created_at (number): Timestamp of when the withdrawal was created.
done_at (number): Timestamp of when the withdrawal was completed.
fee (number): The fee associated with the withdrawal.
tx_id (number): The transaction ID of the withdrawal.
updated_at (number): Timestamp of when the withdrawal was last updated.
uuid (number): The universally unique identifier for the withdrawal.
This endpoint retrieves the available fiat withdrawal providers based on the specified instrument and currency.
\nMethod: GET
\nEndpoint: /api/v2/fiat/withdrawals/providers
Query Parameters:
\ninstrument (string, required): The type of instrument (e.g. sepa)
\ncurrency (string, required): The currency (e.g. eur)
\nThe response for this request can be represented using the following JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"card\": {\n \"type\": \"object\",\n \"properties\": {\n \"card\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n },\n \"bank_transfer\": {\n \"type\": \"object\",\n \"properties\": {\n \"sepa_tag\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n }\n }\n }\n },\n \"sepa\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the withdrawal fees for a specified amount, instrument, and currency.
\nMethod: GET
\nEndpoint: /api/v2/fiat/withdrawals/fees
Query Parameters:
\namount (number): The amount for which withdrawal fees are to be retrieved
instrument (string): The instrument for withdrawal (e.g. SEPA)
currency (string): The currency in which withdrawal is to be made
The response for this request is a JSON object with the following properties:
\ndynamic (string): Description of dynamic withdrawal fee
static (string): Description of static withdrawal fee
min_amount (string): Description of the minimum withdrawal amount
{\n \"type\": \"object\",\n \"properties\": {\n \"dynamic\": { \"type\": \"string\" },\n \"static\": { \"type\": \"string\" },\n \"min_amount\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve the permissions for a specific instrument identified by the 'dchain' parameter.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\"status\"]\n }\n}\n\nThis JSON schema describes the structure of the response where the 'status' key is a boolean value indicating the permission status for the instrument.
\n","urlObject":{"path":["v2","instruments","permissions"],"host":["api"],"query":[{"key":"dchain","value":"cheur"}],"variable":[]}},"response":[{"id":"01ea9a37-1942-4a8f-b197-da12e163473c","name":"Get permissions","originalRequest":{"method":"GET","header":[],"url":{"raw":"api/v2/instruments/permissions?dchain=mmeur","host":["api"],"path":["v2","instruments","permissions"],"query":[{"key":"dchain","value":"mmeur"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n{\r\n\"instrument_id\" : SEPA,\r\n\"operation_id\" : DEPOSIT,\r\n\"status\" : true\r\n},\r\n{\r\n\"instrument_id\" : SEPA,\r\n\"operation_id\" : WITHDRAWAL,\r\n\"status\" : true\r\n},\r\n{\r\n\"instrument_id\" : SEPA_TAG,\r\n\"operation_id\" : DEPOSIT,\r\n\"status\" : true\r\n},\r\n{\r\n\"instrument_id\" : SEPA_TAG,\r\n\"operation_id\" : WITHDRAWAL,\r\n\"status\" : true\r\n}\r\n]"}],"_postman_id":"24fbefd5-3baa-403c-b947-f86ea1f95bb8"}],"id":"41fe71a0-0a89-42b9-83f9-bbd296bbb0b2","_postman_id":"41fe71a0-0a89-42b9-83f9-bbd296bbb0b2","description":""},{"name":"Requisites","item":[{"name":"Retrieves a list of requisites based on various filters","id":"44d98302-2e83-447a-853f-14e36ba63975","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/requisites?page=&per_page=&search=&asset=&dchain&name&address&sort&sort_by","description":"This endpoint retrieves a list of requisites with optional pagination, search, and sorting parameters.
\nRequest Parameters
\npage (optional): The page number for paginating the results.
per_page (optional): The number of items to be included per page.
search (optional): Search keyword to filter the requisites.
asset (optional): Filter by asset ID.
dchain (optional): Filter by dchain ID.
name (optional): Filter by name.
address (optional): Filter by address.
sort (optional): Sort order (asc or desc).
sort_by (optional): Sort by a specific field.
Response
The response includes the total count of requisites, pagination details, and an array of items. Each item contains the following fields:
address: The address of the requisite.
address_control_verified: Indicates if the address control is verified.
asset_id: The ID of the asset.
created_at: The creation timestamp of the requisite.
dchain_id: The ID of the dchain.
deleted_at: Timestamp of deletion, if applicable.
description: Description of the requisite.
id: The ID of the requisite.
name: The name of the requisite.
otp: Indicates if OTP (One-Time Password) is enabled.
tag: Tag associated with the requisite.
uid: The UID of the requisite.
updated_at: The timestamp of the last update.
whitelist: Indicates if the requisite is whitelisted.
Example Response:
\n{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"\",\n \"address_control_verified\": true,\n \"asset_id\": \"\",\n \"created_at\": \"\",\n \"dchain_id\": \"\",\n \"deleted_at\": null,\n \"description\": null,\n \"id\": 0,\n \"name\": \"\",\n \"otp\": true,\n \"tag\": null,\n \"uid\": 0,\n \"updated_at\": \"\",\n \"whitelist\": true\n }\n ]\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Search by partial match on address, tag, description, or name
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Filter by asset (mutually exclusive with dchain)
\n","type":"text/plain"},"key":"asset","value":""},{"description":{"content":"Filter by dchain (mutually exclusive with asset)
\n","type":"text/plain"},"key":"dchain","value":null},{"description":{"content":"Search by name
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Search by address
\n","type":"text/plain"},"key":"address","value":null},{"description":{"content":"Sort order, either asc or desc
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Field to sort by
\n","type":"text/plain"},"key":"sort_by","value":null}],"variable":[]}},"response":[{"id":"d003211f-5488-4d57-a69f-ae590c20b20a","name":"Retrieves a list of requisites based on various filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/requisites?page=&per_page=&search=&asset=&dchain&name&address&sort&sort_by","host":["https://my.kyrrex.mt/api"],"path":["v2","requisites"],"query":[{"key":"page","value":"","description":"Pagination page number"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"search","value":"","description":"Search by partial match on address, tag, description, or name"},{"key":"asset","value":"","description":"Filter by asset (mutually exclusive with dchain)"},{"key":"dchain","value":null,"description":"Filter by dchain (mutually exclusive with asset)"},{"key":"name","value":null,"description":"Search by name"},{"key":"address","value":null,"description":"Search by address"},{"key":"sort","value":null,"description":"Sort order, either asc or desc"},{"key":"sort_by","value":null,"description":"Field to sort by"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 2,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"TWYEoEaLDRLDjnBqbQcupYkcPxyHzNVj2J\",\n \"address_control_verified\": true,\n \"asset_id\": \"usdt\",\n \"created_at\": \"2024-06-03T21:23:38.784Z\",\n \"dchain_id\": \"trc20usdt\",\n \"deleted_at\": null,\n \"description\": null,\n \"id\": 1050,\n \"name\": \"ggg\",\n \"otp\": true,\n \"tag\": null,\n \"uid\": 15589053726,\n \"updated_at\": \"2024-06-03T21:23:38.816Z\",\n \"whitelist\": false\n },\n {\n \"address\": \"TVUkrxZUU2b4o21VGbcvZi32knibRoFCmU\",\n \"address_control_verified\": true,\n \"asset_id\": \"usdt\",\n \"created_at\": \"2024-05-31T20:14:48.949Z\",\n \"dchain_id\": \"trc20usdt\",\n \"deleted_at\": null,\n \"id\": 1037,\n \"name\": \"test\",\n \"otp\": true,\n \"soiled\": false,\n \"tag\": null,\n \"uid\": 15589046472,\n \"updated_at\": \"2024-05-31T20:14:49.312Z\",\n \"whitelist\": false\n }\n ]\n}"}],"_postman_id":"44d98302-2e83-447a-853f-14e36ba63975"},{"name":"Lists requisites with optional filters","id":"ad0ca7a7-34db-4ebc-afe8-44f00e585558","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/fiat/requisites?page=&per_page=&dchain&gateway","description":"This endpoint retrieves a list of fiat requisites with optional pagination parameters.
\npage (optional): The page number for paginated results.
per_page (optional): The number of items per page.
dchain (optional): The blockchain type.
gateway (optional): The gateway for fiat requisites.
The response will be a JSON object with the following properties:
\nlimit (number): The maximum number of items returned.
total_count (number): The total count of items available.
per_page (number): The number of items per page.
total_pages (number): The total number of pages.
page (number): The current page number.
prev_page (null): The previous page number, if available.
next_page (null): The next page number, if available.
items (array): An array of objects representing fiat requisites, with the following properties:
address (string): The address for the requisite.
asset (string): The asset type.
dchain (string): The blockchain type.
expired_at (null): The expiry date, if available.
name (null): The name of the requisite, if available.
tag (null): The tag associated with the requisite, if available.
type (string): The type of requisite.
id (number): The unique identifier for the requisite.
{\n \"type\": \"object\",\n \"properties\": {\n \"limit\": { \"type\": \"number\" },\n \"total_count\": { \"type\": \"number\" },\n \"per_page\": { \"type\": \"number\" },\n \"total_pages\": { \"type\": \"number\" },\n \"page\": { \"type\": \"number\" },\n \"prev_page\": { \"type\": \"null\" },\n \"next_page\": { \"type\": \"null\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": { \"type\": \"string\" },\n \"asset\": { \"type\": \"string\" },\n \"dchain\": { \"type\": \"string\" },\n \"expired_at\": { \"type\": \"null\" },\n \"name\": { \"type\": \"null\" },\n \"tag\": { \"type\": \"null\" },\n \"type\": { \"type\": \"string\" },\n \"id\": { \"type\": \"number\" }\n }\n }\n }\n }\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Filter by dchain (mutually exclusive with asset)
\n","type":"text/plain"},"key":"dchain","value":null},{"description":{"content":"Filter by gateway
\n","type":"text/plain"},"key":"gateway","value":null}],"variable":[]}},"response":[{"id":"2a4b1977-b065-4fe8-aec8-ffdbe0d37a78","name":"Lists requisites with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/requisites?page=&per_page=&asset=&gateway","host":["https://my.kyrrex.mt/api"],"path":["v2","requisites"],"query":[{"key":"page","value":"","description":"Pagination page number"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"asset","value":"","description":"Filter by asset (mutually exclusive with dchain)"},{"key":"gateway","value":null,"description":"Filter by gateway"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 7,\n \"total_count\": 1,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"559606 **** 0931\",\n \"asset\": \"eur\",\n \"dchain\": \"cjeur\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"card_address\",\n \"id\": 2174\n }\n ]\n}"}],"_postman_id":"ad0ca7a7-34db-4ebc-afe8-44f00e585558"}],"id":"9c9f5707-3096-4e7d-a94d-062e29468432","_postman_id":"9c9f5707-3096-4e7d-a94d-062e29468432","description":""},{"name":"Withdrawals","item":[{"name":"Creates a new withdrawal","id":"7eaae8ab-3705-4ede-b992-3e5255dc163e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dchain\": \"trc20usdt\", //Identifier of the dchain\n \"amount\": 50.0, //Amount to be withdrawn\n \"destination\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\", //Address to which the withdrawal will be sent (mutually exclusive with requisite_id)\n \"destination_tag\": \"12345\",//Tag of the destination address\n \"requisite_id\": \"15604287808\"//Identifier of the requisite (mutually exclusive with destination)\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.mt/api/v2/withdrawals","description":"This endpoint allows you to initiate a withdrawal by submitting a POST request to the specified URL.
\ndchain (string): The blockchain type for the withdrawal.
amount (number): The amount to be withdrawn.
destination (string): The destination address for the withdrawal.
destination_tag (string): The destination tag for the withdrawal.
requisite_id (string): The requisite ID for the withdrawal.
Upon successful processing of the request, the API will respond with the following fields:
\naddress (string): The withdrawal address.
amount (number): The withdrawn amount.
asset (string): The asset type.
asset_type (string): The type of asset.
control (boolean): Indicates if the withdrawal is under control.
created_at (string): Timestamp of creation.
dchain_id (string): The ID on the blockchain.
done_at (string): Timestamp of completion.
fee (number): The withdrawal fee.
high_risk (boolean): Indicates if the withdrawal is flagged as high risk.
status (string): The status of the withdrawal.
tag (string): The withdrawal tag.
tx_id (string): The transaction ID.
tx_link (string): The transaction link.
type (string): The type of withdrawal.
updated_at (string): Timestamp of last update.
uuid (number): The UUID of the withdrawal.
This endpoint allows you to retrieve a list of exchanges with optional pagination and filtering.
\npage (optional) - The page number for paginated results.
per_page (optional) - The number of items per page.
input_asset - The input asset for the exchange.
output_asset - The output asset for the exchange.
state (optional) - The state of the exchange.
from (optional) - The start date for filtering exchanges.
to (optional) - The end date for filtering exchanges.
sort (optional) - The sorting order for the results.
sort_by (optional) - The attribute to sort the results by.
The response will include the total count of exchanges, pagination details, and a list of exchange items with their respective details such as amount, created date, currency, executed amount, input and output currency IDs, state, and UUID.
\nExample Response:
\n{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": 0,\n \"items\": [\n {\n \"amount\": 0,\n \"created\": \"\",\n \"currency\": \"\",\n \"executed\": 0,\n \"input_currency_id\": \"\",\n \"output_amount\": 0,\n \"output_currency_id\": \"\",\n \"state\": \"\",\n \"uuid\": 0\n }\n ]\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":" "},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":" "},{"description":{"content":"Identifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":null},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":null},{"description":{"content":"Filter by status
\n","type":"text/plain"},"key":"state","value":" "},{"description":{"content":"Filter by start date
\n","type":"text/plain"},"key":"from","value":" "},{"description":{"content":"Filter by end date
\n","type":"text/plain"},"key":"to","value":" "},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specified field
\n","type":"text/plain"},"key":"sort_by","value":""}],"variable":[]}},"response":[{"id":"ba52ac9a-507c-4cb9-b325-3c2decd7bb4b","name":"Lists exchanges with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/exchanges?page= &per_page= &input_asset&output_asset&state= &from= &to= &sort= &sort_by=","host":["https://my.kyrrex.mt/api"],"path":["v2","exchanges"],"query":[{"key":"page","value":" ","description":"Pagination page number"},{"key":"per_page","value":" ","description":"Number of items per page"},{"key":"input_asset","value":null,"description":"Identifier of the input asset"},{"key":"output_asset","value":null,"description":"Identifier of the output asset"},{"key":"state","value":" ","description":"Filter by status"},{"key":"from","value":" ","description":"Filter by start date"},{"key":"to","value":" ","description":"Filter by end date"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":"","description":"Sort by specified field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 25,\n \"per_page\": 2,\n \"total_pages\": 13,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"amount\": 0.00072279,\n \"created\": \"2024-02-19T23:36:25.421Z\",\n \"currency\": \"btceur\",\n \"executed\": 1.0,\n \"input_currency_id\": \"btc\",\n \"output_amount\": 34.0,\n \"output_currency_id\": \"eur\",\n \"state\": \"done\",\n \"uuid\": 230567216545007490\n },\n {\n \"amount\": 10.0,\n \"created\": \"2024-02-19T23:33:13.281Z\",\n \"currency\": \"eurbtc\",\n \"executed\": 1.0,\n \"input_currency_id\": \"eur\",\n \"output_amount\": 0.000208,\n \"output_currency_id\": \"btc\",\n \"state\": \"done\",\n \"uuid\": 230567216545007428\n }\n ]\n}"}],"_postman_id":"72c09adc-580b-4388-b83c-a132142fd753"},{"name":"Creates a new exchange","id":"fd90d081-e886-47c8-ae69-17fbedac8962","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.kyrrex.mt/api/v2/exchanges?input_asset&output_asset&amount","description":"The HTTP POST request to https://my.kyrrex.mt/api/v2/exchanges is used to exchange input asset for output asset with a specified amount.
input_asset (required): The input asset for the exchange.
output_asset (required): The desired output asset for the exchange.
amount (required): The amount of input asset to be exchanged.
The response for this request will be a JSON object with the following properties:
\namount: The amount of the input asset for the exchange.
created: The timestamp for when the exchange was created.
currency: The currency of the exchange.
executed: The amount executed for the exchange.
input_currency_id: The ID of the input currency.
output_amount: The amount of the output asset.
output_currency_id: The ID of the output currency.
state: The state of the exchange.
uuid: The UUID of the exchange.
{\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\"type\": \"number\"},\n \"created\": {\"type\": \"string\"},\n \"currency\": {\"type\": \"string\"},\n \"executed\": {\"type\": \"number\"},\n \"input_currency_id\": {\"type\": \"string\"},\n \"output_amount\": {\"type\": \"number\"},\n \"output_currency_id\": {\"type\": \"string\"},\n \"state\": {\"type\": \"string\"},\n \"uuid\": {\"type\": \"string\"}\n }\n}\n\nIdentifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":null},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":null},{"description":{"content":"Amount to be exchanged
\n","type":"text/plain"},"key":"amount","value":null}],"variable":[]}},"response":[{"id":"cee3e327-ff15-4f9d-9b8a-1335c33879a9","name":"Creates a new exchange","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/exchanges?input_asset&output_asset&amount","host":["https://my.kyrrex.mt/api"],"path":["v2","exchanges"],"query":[{"key":"input_asset","value":null,"description":"Identifier of the input asset"},{"key":"output_asset","value":null,"description":"Identifier of the output asset"},{"key":"amount","value":null,"description":"Amount to be exchanged"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 10.0,\n \"created\": \"2024-02-19T23:33:13.281Z\",\n \"currency\": \"eurbtc\",\n \"executed\": 1.0,\n \"input_currency_id\": \"eur\",\n \"output_amount\": 0.000208,\n \"output_currency_id\": \"btc\",\n \"state\": \"done\",\n \"uuid\": 230567216545007428\n}"}],"_postman_id":"fd90d081-e886-47c8-ae69-17fbedac8962"},{"name":"Estimates an exchange rate for given assets and amount","id":"3cb0c2ac-2278-4a7f-a179-858991bc1c14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/exchanges/estimate?input_asset=&output_asset=&amount","description":"This endpoint retrieves an estimate for exchanging one asset to another based on the provided input asset, output asset, and amount.
\nMethod: GET
\nEndpoint: https://my.kyrrex.mt/api/v2/exchanges/estimate
Query Parameters:
\ninput_asset (required): The input asset for the exchange.
output_asset (required): The output asset for the exchange.
amount (required): The amount of input asset to be exchanged.
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"input\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\n \"type\": \"number\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"minimum_amount\": {\n \"type\": \"number\"\n }\n }\n },\n \"output\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\n \"type\": \"number\"\n },\n \"currency\": {\n \"type\": \"string\"\n }\n }\n },\n \"rate\": {\n \"type\": \"number\"\n }\n }\n}\n\nThe response body consists of the following key-value pairs:
\ninput: Contains information about the input asset, including the amount, currency, and minimum amount.
output: Contains information about the output asset, including the amount and currency.
rate: Represents the exchange rate for the specified input and output assets.
Identifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":""},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":""},{"description":{"content":"Amount to be exchanged
\n","type":"text/plain"},"key":"amount","value":null}],"variable":[]}},"response":[{"id":"e0318892-5c6f-425e-bd64-e5ec7640b396","name":"Estimates an exchange rate for given assets and amount","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/exchanges/estimate?input_asset=&output_asset=&amount","host":["https://my.kyrrex.mt/api"],"path":["v2","exchanges","estimate"],"query":[{"key":"input_asset","value":"","description":"Identifier of the input asset"},{"key":"output_asset","value":"","description":"Identifier of the output asset"},{"key":"amount","value":null,"description":"Amount to be exchanged"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"input\": {\n \"amount\": 1000.0,\n \"currency\": \"usdt\",\n \"minimum_amount\": 5.0\n },\n \"output\": {\n \"amount\": 0.01538802,\n \"currency\": \"btc\"\n },\n \"rate\": 64985.6\n}"}],"_postman_id":"3cb0c2ac-2278-4a7f-a179-858991bc1c14"}],"id":"f5b104cc-0df6-469d-934c-e766805eadfe","_postman_id":"f5b104cc-0df6-469d-934c-e766805eadfe","description":""},{"name":"Orders","item":[{"name":"Lists orders with optional filters","id":"c2f61255-3b88-418c-b8a0-6bb1a55b77a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/orders?market=&from=&to=&asset=&state=&side=&ord_type=&price_min=&price_max=&sort= &sort_by=&page=&per_page=","description":"The endpoint retrieves a list of orders based on the provided query parameters. The response is a JSON object with various fields. Here is a JSON schema representing the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"prices\": {\n \"type\": \"object\",\n \"properties\": {\n \"sell\": {\n \"type\": \"array\",\n \"items\": {}\n },\n \"buy\": {\n \"type\": \"array\",\n \"items\": {}\n }\n }\n },\n \"order\": {\n \"type\": \"null\"\n },\n \"total_count\": {\n \"type\": \"integer\"\n },\n \"per_page\": {\n \"type\": \"integer\"\n },\n \"total_pages\": {\n \"type\": \"integer\"\n },\n \"page\": {\n \"type\": \"integer\"\n },\n \"prev_page\": {\n \"type\": \"null\"\n },\n \"next_page\": {\n \"type\": \"integer\"\n },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"avg_price\": {\n \"type\": [\"number\", \"null\"]\n },\n \"created_at\": {\n \"type\": \"string\"\n },\n \"executed_volume\": {\n \"type\": \"integer\"\n },\n \"fulfillment\": {\n \"type\": \"integer\"\n },\n \"id\": {\n \"type\": \"integer\"\n },\n \"market_id\": {\n \"type\": \"string\"\n },\n \"ord_type\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\"\n },\n \"remaining_volume\": {\n \"type\": \"integer\"\n },\n \"side\": {\n \"type\": \"string\"\n },\n \"state\": {\n \"type\": \"string\"\n },\n \"trades_count\": {\n \"type\": \"integer\"\n },\n \"volume\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\"created_at\", \"executed_volume\", \"fulfillment\", \"id\", \"market_id\", \"ord_type\", \"price\", \"remaining_volume\", \"side\", \"state\", \"trades_count\", \"volume\"]\n }\n }\n },\n \"required\": [\"prices\", \"order\", \"total_count\", \"per_page\", \"total_pages\", \"page\", \"prev_page\", \"next_page\", \"items\"]\n}\nThis endpoint retrieves the details of a specific order by providing the order ID in the endpoint URL.
\nMethod: GET
\nEndpoint: https://my.kyrrex.mt/api/v2/orders/{id}
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"avg_price\": { \"type\": [\"number\", \"null\"] },\n \"created_at\": { \"type\": \"string\" },\n \"executed_volume\": { \"type\": \"number\" },\n \"fulfillment\": { \"type\": \"number\" },\n \"id\": { \"type\": \"number\" },\n \"market_id\": { \"type\": \"string\" },\n \"ord_type\": { \"type\": \"string\" },\n \"price\": { \"type\": \"number\" },\n \"remaining_volume\": { \"type\": \"number\" },\n \"side\": { \"type\": \"string\" },\n \"state\": { \"type\": \"string\" },\n \"trades_count\": { \"type\": \"number\" },\n \"volume\": { \"type\": \"number\" }\n }\n}\n\nThis endpoint allows you to place a new order in the specified market.
\nmarket (string): The market in which the order will be placed.
side (string): The side of the order, e.g., buy or sell.
ord_type (string): The type of order, e.g., limit or market.
volume (string): The volume of the order.
price (string): The price at which the order will be executed.
The response will contain the details of the newly created order, including the following information:
\navg_price (null): The average price of the order.
created_at (string): The timestamp when the order was created.
executed_volume (number): The volume of the order that has been executed.
fulfillment (number): The fulfillment status of the order.
id (number): The ID of the order.
market_id (string): The ID of the market.
ord_type (string): The type of order.
price (number): The price at which the order will be executed.
remaining_volume (number): The remaining volume of the order.
side (string): The side of the order.
state (string): The state of the order.
trades_count (number): The number of trades associated with the order.
volume (number): The total volume of the order.
Market identifier
\n","type":"text/plain"},"key":"market","value":null},{"description":{"content":"Order direction
\n","type":"text/plain"},"key":"side","value":null},{"description":{"content":"Order type
\n","type":"text/plain"},"key":"ord_type","value":null},{"description":{"content":"Order volume
\n","type":"text/plain"},"key":"volume","value":null},{"description":{"content":"Order price (required for limit order type)
\n","type":"text/plain"},"key":"price","value":null}],"variable":[]}},"response":[{"id":"38f27431-2782-4fe3-80cc-90d3b1f629e9","name":"Creates a new order","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/orders?market&side&ord_type&volume&price","host":["https://my.kyrrex.mt/api"],"path":["v2","orders"],"query":[{"key":"market","value":null,"description":"Market identifier"},{"key":"side","value":null,"description":"Order direction"},{"key":"ord_type","value":null,"description":"Order type"},{"key":"volume","value":null,"description":"Order volume"},{"key":"price","value":null,"description":"Order price (required for limit order type)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"avg_price\": null,\n \"created_at\": \"2022-08-26T09:36:56.629Z\",\n \"executed_volume\": 0.0024,\n \"fulfillment\": 0.24,\n \"id\": 737,\n \"market_id\": \"btcusdt\",\n \"ord_type\": \"limit\",\n \"price\": 1000.0,\n \"remaining_volume\": 0.0076,\n \"side\": \"buy\",\n \"state\": \"wait\",\n \"trades_count\": 5,\n \"volume\": 0.01\n}"}],"_postman_id":"aa42322b-3f45-4013-8b1f-d2ba8dc76d78"},{"name":"Cancels an order by ID","id":"41095bcf-5698-409c-a1d1-f20f12721785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://my.kyrrex.mt/api/v2/orders/{id}","description":"This endpoint is used to delete a specific order by providing the order ID in the URL.
\nRequest Body
This request does not require a request body.
Response
\n{\n \"status\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates the status of the deletion operation. A value of `true` signifies a successful deletion.\"\n }\n}\n\nThis endpoint is used to delete an order.
\nRequest Body
This request does not require a request body.
Response
\nstatus (boolean, required): Indicates the status of the deletion operation. Returns true if the deletion was successful.This API endpoint retrieves a list of trades based on the specified filters.
\nmarket (optional): Filter trades by market.
side (optional): Filter trades by side (buy/sell).
asset (optional): Filter trades by asset.
from (optional): Filter trades from a specific date.
to (optional): Filter trades to a specific date.
page (optional): Specify the page number for paginated results.
per_page (optional): Specify the number of trades per page.
sort (optional): Specify the sort order (asc/desc).
sort_by (optional): Specify the attribute to sort the trades by.
The response will include a list of trades based on the applied filters, including trade details such as trade ID, market, side, price, volume, and timestamp.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"trades\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"trade_id\": {\n \"type\": \"string\"\n },\n \"market\": {\n \"type\": \"string\"\n },\n \"side\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\"\n },\n \"volume\": {\n \"type\": \"number\"\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n }\n }\n }\n }\n }\n}\n\nMarket identifier
\n","type":"text/plain"},"key":"market","value":""},{"description":{"content":"Trade direction
\n","type":"text/plain"},"key":"side","value":""},{"description":{"content":"Asset identifier
\n","type":"text/plain"},"key":"asset","value":""},{"description":{"content":"Filter by start date
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"Filter by end date
\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"Pagination page
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specified field
\n","type":"text/plain"},"key":"sort_by","value":""}],"variable":[]}},"response":[{"id":"ab5173b4-28d3-4558-9026-2949ed7a5c17","name":"Lists trades with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.mt/api/v2/trades?market=&side=&asset=&from=&to=&page=&per_page=&sort= &sort_by=","host":["https://my.kyrrex.mt/api"],"path":["v2","trades"],"query":[{"key":"market","value":"","description":"Market identifier"},{"key":"side","value":"","description":"Trade direction"},{"key":"asset","value":"","description":"Asset identifier"},{"key":"from","value":"","description":"Filter by start date"},{"key":"to","value":"","description":"Filter by end date"},{"key":"page","value":"","description":"Pagination page"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":"","description":"Sort by specified field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"order\": \"created_at desc\",\n \"total_count\": 104,\n \"per_page\": 2,\n \"total_pages\": 52,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"created_at\": \"2022-08-17T20:28:36Z\",\n \"fee\": 0.00001,\n \"fee_asset\": \"btc\",\n \"funds\": 10.0,\n \"funds_asset\": \"usdt\",\n \"id\": 482,\n \"in_asset_id\": \"btc\",\n \"market\": \"btcusdt\",\n \"order_id\": 669,\n \"out_asset_id\": \"usdt\",\n \"price\": 1000.0,\n \"side\": \"buy\",\n \"type\": \"buy\",\n \"volume\": 0.01,\n \"volume_asset\": \"btc\"\n },\n {\n \"created_at\": \"2022-09-01T16:40:37Z\",\n \"fee\": 0.000001,\n \"fee_asset\": \"btc\",\n \"funds\": 1.0,\n \"funds_asset\": \"usdt\",\n \"id\": 2060,\n \"in_asset_id\": \"btc\",\n \"market\": \"btcusdt\",\n \"order_id\": 737,\n \"out_asset_id\": \"usdt\",\n \"price\": 1000.0,\n \"side\": \"sell\",\n \"type\": \"sell\",\n \"volume\": 0.001,\n \"volume_asset\": \"btc\"\n }\n ]\n}"}],"_postman_id":"d5ed56e6-f9eb-438d-8ba0-80bc2e6d1b51"}],"id":"c22087da-6736-48d7-adc5-081a03cb4951","_postman_id":"c22087da-6736-48d7-adc5-081a03cb4951","description":""},{"name":"Settings","item":[{"name":"Lists available markets with their configurations","id":"f6cbd1d4-d6b2-4602-bf0a-1738d6f785e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/settings/markets","description":"This endpoint makes an HTTP GET request to retrieve the markets settings from the specified domain. The request does not require a request body as it is a GET request. The response will include the market settings data, which may consist of various parameters such as market names, IDs, and configuration details.
\n","urlObject":{"path":["v2","settings","markets"],"host":["https://my.kyrrex.mt/api"],"query":[],"variable":[]}},"response":[{"id":"81cb06f6-796b-4b10-964c-be5107300c16","name":"Lists available markets with their configurations","originalRequest":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/settings/markets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"usdt\",\n \"maker_fee\": 0.0015,\n \"market\": \"usdteur\",\n \"min_amount\": 10.0,\n \"min_volume\": 10.0,\n \"quote_precision\": 4,\n \"quote_unit\": \"eur\",\n \"taker_fee\": 0.0015\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"trx\",\n \"maker_fee\": 0.01,\n \"market\": \"trxeur\",\n \"min_amount\": 10.0,\n \"min_volume\": 10.0,\n \"quote_precision\": 6,\n \"quote_unit\": \"eur\",\n \"taker_fee\": 0.01\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"btc\",\n \"maker_fee\": 0.01,\n \"market\": \"btceur\",\n \"min_amount\": 10.0,\n \"min_volume\": 0.0001,\n \"quote_precision\": 1,\n \"quote_unit\": \"eur\",\n \"taker_fee\": 0.01\n },\n {\n \"active\": true,\n \"base_precision\": 2,\n \"base_unit\": \"ltc\",\n \"maker_fee\": 0.001,\n \"market\": \"ltcbtc\",\n \"min_amount\": 0.0003,\n \"min_volume\": 0.1,\n \"quote_precision\": 6,\n \"quote_unit\": \"btc\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 0,\n \"base_unit\": \"xlm\",\n \"maker_fee\": 0.001,\n \"market\": \"xlmbtc\",\n \"min_amount\": 0.0001,\n \"min_volume\": 1.0,\n \"quote_precision\": 8,\n \"quote_unit\": \"btc\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 3,\n \"base_unit\": \"eth\",\n \"maker_fee\": 0.001,\n \"market\": \"ethbtc\",\n \"min_amount\": 0.002,\n \"min_volume\": 0.01,\n \"quote_precision\": 6,\n \"quote_unit\": \"btc\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 4,\n \"base_unit\": \"bch\",\n \"maker_fee\": 0.003,\n \"market\": \"bchusdt\",\n \"min_amount\": 5.0,\n \"min_volume\": 0.01,\n \"quote_precision\": 2,\n \"quote_unit\": \"usdt\",\n \"taker_fee\": 0.003\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"eth\",\n \"maker_fee\": 0.0015,\n \"market\": \"ethusdt\",\n \"min_amount\": 25.0,\n \"min_volume\": 0.01,\n \"quote_precision\": 2,\n \"quote_unit\": \"usdt\",\n \"taker_fee\": 0.0015\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"ltc\",\n \"maker_fee\": 0.001,\n \"market\": \"ltcusdt\",\n \"min_amount\": 5.0,\n \"min_volume\": 0.1,\n \"quote_precision\": 5,\n \"quote_unit\": \"usdt\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 0,\n \"base_unit\": \"xrp\",\n \"maker_fee\": 0.001,\n \"market\": \"xrpbtc\",\n \"min_amount\": 0.0002,\n \"min_volume\": 1.0,\n \"quote_precision\": 8,\n \"quote_unit\": \"btc\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"bch\",\n \"maker_fee\": 0.001,\n \"market\": \"bchbtc\",\n \"min_amount\": 0.0001,\n \"min_volume\": 0.001,\n \"quote_precision\": 6,\n \"quote_unit\": \"btc\",\n \"taker_fee\": 0.001\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"xrp\",\n \"maker_fee\": 0.03,\n \"market\": \"xrpusdt\",\n \"min_amount\": 5.0,\n \"min_volume\": 5.0,\n \"quote_precision\": 5,\n \"quote_unit\": \"usdt\",\n \"taker_fee\": 0.01\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"btc\",\n \"maker_fee\": 0.0015,\n \"market\": \"btcusdt\",\n \"min_amount\": 5.0,\n \"min_volume\": 0.0001,\n \"quote_precision\": 1,\n \"quote_unit\": \"usdt\",\n \"taker_fee\": 0.0015\n },\n {\n \"active\": true,\n \"base_precision\": 8,\n \"base_unit\": \"eth\",\n \"maker_fee\": 0.0,\n \"market\": \"etheur\",\n \"min_amount\": 10.0,\n \"min_volume\": 0.002,\n \"quote_precision\": 2,\n \"quote_unit\": \"eur\",\n \"taker_fee\": 0.0\n }\n]"}],"_postman_id":"f6cbd1d4-d6b2-4602-bf0a-1738d6f785e5"},{"name":"Lists available currencies with their configurations","id":"5e2344ba-159d-4fb3-a6ea-091a8215a7f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.mt/api/v2/settings/currencies","description":"This endpoint retrieves the currency settings from the server.
\nMethod: GET
\nURL: https://my.kyrrex.mt/api/v2/settings/currencies
Body: N/A
\nThe response will include the following parameters:
\ncode: The currency code.
dchains: An array of objects containing detailed information about the currency's chains, including display name, account details, deposit details, and withdrawal details.
dcode: The chain code.
display_name: The display name of the chain.
account: An object containing min and max account balance details.
min_account_balance: The minimum account balance.
max_account_balance: The maximum account balance.
deposit: An object containing static fee, dynamic fee, AML fee, min amount, and max amount details for deposits.
static_fee: The static fee for deposits.
dynamic_fee: The dynamic fee for deposits.
aml_fee: The AML fee for deposits.
min_amount: The minimum amount for deposits.
max_amount: The maximum amount for deposits.
withdraw: An object containing static fee, dynamic fee, AML fee, min amount, and max amount details for withdrawals.
static_fee: The static fee for withdrawals.
dynamic_fee: The dynamic fee for withdrawals.
aml_fee: The AML fee for withdrawals.
min_amount: The minimum amount for withdrawals.
max_amount: The maximum amount for withdrawals.
name: The name of the currency.
precision: The precision of the currency.
type: The type of the currency.
Example response:
\n[\n {\n \"code\": \"USD\",\n \"dchains\": [\n {\n \"dcode\": \"USD\",\n \"display_name\": \"US Dollar\",\n \"account\": {\n \"min_account_balance\": \"\",\n \"max_account_balance\": \"\"\n },\n \"deposit\": {\n \"static_fee\": \"\",\n \"dynamic_fee\": \"\",\n \"aml_fee\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n },\n \"withdraw\": {\n \"static_fee\": \"\",\n \"dynamic_fee\": \"\",\n \"aml_fee\": \"\",\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n }\n }\n ],\n \"name\": \"\",\n \"precision\": 0,\n \"type\": \"\"\n }\n]\n\nThis endpoint retrieves the current timestamp.
\nThis is a simple GET request with no request body.
\nThe response for this request is a JSON object with a single property \"timestamp\" representing the current timestamp.
\nRequest Body
\nResponse Body
\n{\n \"timestamp\": 0\n}\n\nResponse JSON Schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"timestamp\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\"timestamp\"]\n}\n\nThis endpoint makes an HTTP GET request to retrieve information about services from the specified domain. The request does not include a request body, and the response contains details about the bonus service, including its status, asset, and minimum bonus withdrawal amount.
\nThe response will be in JSON format and may include the \"bonus_service\" object with the \"status\" field indicating the service status, \"asset\" field indicating the associated asset, and \"minimum_bonus_withdrawal_amount\" field indicating the minimum amount for bonus withdrawal.
\nExample response:
\n{\n \"bonus_service\": {\n \"status\": true,\n \"asset\": \"\",\n \"minimum_bonus_withdrawal_amount\": \"\"\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve information about tools from the specified domain.
\nThis request does not require a request body.
\ntool_name: (string) The name of the tool.
tool_description: (string) A brief description of the tool.
tool_version: (string) The version of the tool.
tool_status: (string) The status of the tool.
This endpoint retrieves a list of countries with their associated details. It is useful for applications that need to display or utilize country information.
\nGET https://my.kyrrex.mt/api/v2/tools/countries
GET
This endpoint requires authentication. Ensure that you include the necessary authentication headers in your request.
\nThis endpoint does not accept any query parameters.
\nThis endpoint does not require a request body.
\nThe response will be a JSON array containing country objects. Each object includes the following fields:
\ncode: (string) The country code.
\neng_name: (string) The English name of the country.
\nid: (integer) The unique identifier for the country.
\niso: (integer) The ISO code for the country.
\nlocation: (string) The geographical location of the country.
\n[\n {\n \"code\": \"\",\n \"eng_name\": \"\",\n \"id\": 0,\n \"iso\": 0,\n \"location\": \"\"\n }\n]\n\nEnsure that your request is authenticated to receive the correct response.
\nThe response fields may vary based on the country data available in the system.
\n