{ "item": [ { "id": "70fb69e0-904b-4a89-b089-cf889a47ffc7", "name": "Currencies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "65a8f5c7-e6ab-4f72-b796-f88312da1057", "name": "Get currencies", "request": { "name": "Get currencies", "description": { "content": "Returns a list of all cryptocurrencies supported by the **SimpleSwap** platform.\n\nThis endpoint provides metadata for all available currencies, including their names, tickers, networks, and other properties required to build exchange flows.\n\nEach currency in the response is uniquely identified by the combination of its `ticker` and `network`, since the same ticker may exist on multiple networks.\n\nThis endpoint is typically used to:\n- Retrieve the full list of supported currencies and networks\n- Build currency selectors in client applications\n- Validate whether a specific currency and network are supported\n- Cache available currencies for use in exchange flows\n\nNotes\n- Each currency is uniquely identified by the combination of its `ticker` and `network`.\n- Currency availability may change over time depending on market and network conditions.\n- Clients are encouraged to cache the response and avoid requesting this endpoint too frequently.\n\n:::warning Extra ID requirements\nIf a currency has `hasExtraId = true`, an additional identifier must be provided when creating an exchange. \nThe required field depends on how the currency is used in the exchange:\n- If the currency is used as the destination currency, the corresponding value must be provided in `extraIdTo`.\n- If the currency is used as the source currency and `userRefundAddress` is specified, the corresponding value must be provided in `userRefundExtraId`.\n- The type or label of the required identifier is specified in the `extraId` field of the currency data.\n:::\n", "type": "text/plain" }, "url": { "path": [ "v3", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1d94f8d0-86e7-4810-815d-c1884ddded27", "originalRequest": { "url": { "path": [ "v3", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": [\n {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n }\n ],\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa6c91a-4275-4fa4-abfb-e0a96dc34166", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4e97f30-158c-4f8e-aaea-6fcb8abd3455", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53004421-0da8-4e67-a455-dbbbd641bf15", "name": "Get currency", "request": { "name": "Get currency", "description": { "content": "Returns detailed information about a specific cryptocurrency supported by the **SimpleSwap** platform.\n\nThis endpoint allows you to retrieve metadata for a single currency, such as its name, ticker, network, and other properties required to build exchange flows.\n\nThe currency is uniquely identified by the combination of its `ticker` and `network`.\n\nThis endpoint is typically used to:\n- Display detailed currency information in a UI\n- Validate whether a specific currency-network pair is supported\n- Determine the correct network before creating an exchange\n\nNotes\n- A currency ticker alone is not sufficient to identify a currency; both ticker and network must be provided.\n- Some currencies may be temporarily unavailable for exchange.\n- Currency details may change over time and should not be assumed to be static.\n\n:::warning Extra ID requirements\nIf a currency has `hasExtraId = true`, an additional identifier must be provided when creating an exchange. \nThe required field depends on how the currency is used in the exchange:\n- If the currency is used as the destination currency, the corresponding value must be provided in `extraIdTo`.\n- If the currency is used as the source currency and `userRefundAddress` is specified, the corresponding value must be provided in `userRefundExtraId`.\n- The type or label of the required identifier is specified in the `extraId` field of the currency data.\n:::\n", "type": "text/plain" }, "url": { "path": [ "v3", "currencies", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "da38a669-5756-45e0-a471-8ed724c37703", "originalRequest": { "url": { "path": [ "v3", "currencies", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef7717ac-d7e6-4394-91bf-cc00d67fd34b", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "currencies", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e6f8268-8eb1-4bff-b186-33376abe0c41", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "currencies", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd933a1-7b7d-4fbf-83f7-f3aae1914584", "name": "Ticker not found", "originalRequest": { "url": { "path": [ "v3", "currencies", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7653047a-19e5-452a-9a56-b1d8ff1f0c7e", "name": "Pairs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "11cab77b-fe70-40ad-9eea-d0111bdc3e81", "name": "Get all exchange pairs", "request": { "name": "Get all exchange pairs", "description": { "content": "Returns all available exchange pairs supported by the **SimpleSwap** platform.\n\nThis endpoint provides a complete mapping of all supported currency pairs, where each currency is identified by the composite key ticker:network and mapped to a list of currencies it can be exchanged to.\n\nThe response is intended to be used for building pair selectors, validating exchange directions, and caching supported exchange routes in client applications.\n\nThis endpoint is typically used to:\n- Build and cache exchange route maps in client applications\n- Validate whether a specific exchange direction is supported\n- Reduce repeated calls to more specific pair endpoints by caching all available pairs\n\nNotes\n- This data changes infrequently.\n- There is no practical benefit in requesting this endpoint more often than once per 5 minutes.\n- Clients are strongly encouraged to cache the response to reduce unnecessary requests.", "type": "text/plain" }, "url": { "path": [ "v3", "pairs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fixed", "value": "false", "description": "(Required) Pass \"false\" if you want to request floating-rate pairs, \"true\" for fixed-rate pairs" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ef385a7a-b89d-417d-9068-e5e9c4cad5ca", "originalRequest": { "url": { "path": [ "v3", "pairs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"key_0\": [\n \"string\",\n \"string\"\n ],\n \"key_1\": [\n \"string\",\n \"string\"\n ]\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1537aff-4b75-473a-b3db-c1bc37fdc68e", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "pairs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280a5422-aad2-449b-9f6f-de2c00f5c4b8", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "pairs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69cc3c21-c42d-4889-98cd-62dcec69553d", "name": "Get currency pairs", "request": { "name": "Get currency pairs", "description": { "content": "Returns all exchange pairs available for a specific currency.\n\nThis endpoint provides a list of currencies that can be exchanged from the specified currency.\n\nThe response maps a source currency (`ticker:network`) to a list of currencies it can be exchanged to, each represented as `ticker:network`.\n\nThis endpoint is typically used to:\n- Build currency pair selectors in the UI\n- Determine which exchanges are available for a given currency\n- Validate whether a specific currency pair can be used before requesting ranges or estimates\n\nNotes\n- Each mapped value represents a list of currencies that the source currency can be exchanged to.\n- Pair availability may vary depending on market conditions.\n- Clients are encouraged to cache the response and avoid requesting this endpoint excessively.\n", "type": "text/plain" }, "url": { "path": [ "v3", "pairs", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fixed", "value": "false", "description": "Set this parameter to `true` to request fixed-rate pairs, or to `false` to request floating-rate pairs." } ], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d4d4f1e4-8e9c-4fe2-b018-3c3f7e2dd9a1", "originalRequest": { "url": { "path": [ "v3", "pairs", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"key_0\": [\n \"string\",\n \"string\"\n ]\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c3ddea8-eb28-468e-a71b-4bd8a8e53a14", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "pairs", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c1a5cc-34f7-4305-9e99-a30e6f786f72", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "pairs", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f63dbb50-485f-4dfd-87b7-e745997e3eb1", "name": "Ticker not found", "originalRequest": { "url": { "path": [ "v3", "pairs", ":ticker", ":network" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "eth", "key": "ticker", "description": "(Required) Currency ticker symbol" }, { "disabled": false, "type": "any", "value": "eth", "key": "network", "description": "(Required) Blockchain network of the currency" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0de14136-cd45-43a7-8970-506ad2b1e06c", "name": "Estimates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ffe67d55-109c-44f4-bd9c-8e9dd0495ffd", "name": "Get exchange estimate", "request": { "name": "Get exchange estimate", "description": { "content": "Returns an estimated exchange calculation for a given currency pair before creating an exchange.\n\nThis endpoint allows you to preview the expected exchange rate, output amount, and related parameters based on the selected input currency, output currency, and amount.\n\nThe estimate is calculated using current market data and is provided for informational purposes only.\n\nFinal exchange amounts may vary due to market volatility and network conditions.\n\nThis endpoint is typically used to:\n- Display estimated exchange results to users\n- Validate exchange parameters before creating an exchange\n- Build quote and preview flows in client applications\n\nNotes\n- The estimate is provided for informational purposes only and does not guarantee the final exchange result.\n- For fixed-rate estimates, the returned rateId must be used when creating the exchange.\n- Clients should request a new estimate if exchange parameters change.\n", "type": "text/plain" }, "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tickerFrom", "value": "btc", "description": "(Required) The ticker of a currency the client will transfer" }, { "disabled": false, "key": "networkFrom", "value": "btc", "description": "(Required) The network of a currency the client will transfer" }, { "disabled": false, "key": "tickerTo", "value": "eth", "description": "(Required) The ticker of a currency the client will receive" }, { "disabled": false, "key": "networkTo", "value": "eth", "description": "(Required) The network of a currency the client will receive" }, { "disabled": false, "key": "fixed", "value": "false", "description": "Set this parameter to `true` to request fixed-rate pairs, or to `false` to request floating-rate pairs." }, { "disabled": false, "key": "reverse", "value": "false", "description": "Set to `true` to calculate the exchange based on the desired receive amount instead of the send amount." }, { "disabled": false, "key": "amount", "value": "0.2", "description": "(Required) The amount to be exchanged.\nMust be a positive number or a string representation of a positive number." }, { "disabled": false, "key": "customFee", "value": "", "description": "A custom partner fee applied to the exchange.\n\nThe value must be between 0.4 and 5 and may contain at most one decimal place.\n\nWhen provided, this value overrides the partner fee configured for the API key in the Partner Dashboard." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8786d418-1426-4e73-bad5-aa7266038fea", "originalRequest": { "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" }, { "key": "amount", "value": "0.2" }, { "key": "customFee", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"estimatedAmount\": \"12.42905138\",\n \"rateId\": \"guzrd4m90w25f3_tag38g8cmk5m6ck39\",\n \"validUntil\": \"2024-09-05T08:35:29.936Z\"\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95864037-0f01-4838-ab92-4e60aa5b5977", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" }, { "key": "amount", "value": "0.2" }, { "key": "customFee", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee71e2cd-8df0-4c54-aff7-0b74b9592699", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" }, { "key": "amount", "value": "0.2" }, { "key": "customFee", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d01937a-9815-433d-a797-b8dca3dd6aeb", "name": "Pair not found", "originalRequest": { "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" }, { "key": "amount", "value": "0.2" }, { "key": "customFee", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3771ecf-34cb-4dae-905d-1e9a33237d4a", "name": "Amount is out of range", "originalRequest": { "url": { "path": [ "v3", "estimates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" }, { "key": "amount", "value": "0.2" }, { "key": "customFee", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "aa5c1c0e-18e3-420b-a3f5-74e27c66fd0e", "name": "Ranges", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e3edb82f-8eba-4cbe-a0bb-e650fcbe2826", "name": "Get exchange ranges", "request": { "name": "Get exchange ranges", "description": { "content": "Returns the minimum and maximum exchange amounts available for a specific currency pair.\n\nThis endpoint allows you to determine the valid input amount range for an exchange based on the selected source and destination currencies.\n\nThe returned range defines the allowed limits for creating an exchange and should be used to validate user input before requesting an estimate or creating an exchange.\n\nThis endpoint is typically used to:\n- Validate exchange amount limits\n- Display minimum and maximum allowed values in the UI\n- Prevent exchange creation with invalid amounts\n\nNotes\n- If the minimum or maximum value is returned as `null`, no corresponding limit is enforced.\n- Clients should validate user input against these limits before requesting an estimate or creating an exchange.\n- Range values may change over time and should not be cached indefinitely.\n", "type": "text/plain" }, "url": { "path": [ "v3", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tickerFrom", "value": "btc", "description": "(Required) The ticker of a currency the client will transfer" }, { "disabled": false, "key": "networkFrom", "value": "btc", "description": "(Required) The network of a currency the client will transfer" }, { "disabled": false, "key": "tickerTo", "value": "eth", "description": "(Required) The ticker of a currency the client will receive" }, { "disabled": false, "key": "networkTo", "value": "eth", "description": "(Required) The network of a currency the client will receive" }, { "disabled": false, "key": "fixed", "value": "false", "description": "Set this parameter to `true` to request fixed-rate pairs, or to `false` to request floating-rate pairs." }, { "disabled": false, "key": "reverse", "value": "false", "description": "Set to `true` to calculate the exchange based on the desired receive amount instead of the send amount." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "be0608f2-30d8-487d-afe5-8669391b7895", "originalRequest": { "url": { "path": [ "v3", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"min\": \"0.001\",\n \"max\": \"0.002\"\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fbabd97-9628-4872-9212-8ccede73b51f", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89d32243-8f1e-4b0e-a79b-e89b4e6dea70", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b705a4d4-6a9e-48ed-a3ef-aa30c09016f7", "name": "Pair not found", "originalRequest": { "url": { "path": [ "v3", "ranges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2d0607f0-1716-4515-8190-beb8e79e3966", "name": "Exchanges", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "346ee6c1-0dc9-410a-a92c-d9aae0495087", "name": "Check exchange availability", "request": { "name": "Check exchange availability", "description": { "content": "Checks whether an exchange can be created using the specified parameters without actually creating the exchange.\n\nThis endpoint validates the requested currency pair, amount, rate type, and other exchange parameters, and returns whether the exchange is currently possible.\n\nIt is intended to be used as a pre-validation step before requesting an estimate or creating an exchange, allowing clients to detect unsupported pairs, invalid amounts, or temporary restrictions in advance.\n\nThis endpoint is typically used to:\n- Validate exchange parameters before creation\n- Prevent failed exchange attempts\n- Improve user experience by detecting issues early\n\nNotes\n- No exchange is created as a result of this request.\n- The availability may change over time depending on market conditions.\n- Clients should not assume availability without performing this check or requesting an estimate.", "type": "text/plain" }, "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "tickerFrom", "value": "btc", "description": "(Required) The ticker of a currency the client will transfer" }, { "disabled": false, "key": "networkFrom", "value": "btc", "description": "(Required) The network of a currency the client will transfer" }, { "disabled": false, "key": "tickerTo", "value": "eth", "description": "(Required) The ticker of a currency the client will receive" }, { "disabled": false, "key": "networkTo", "value": "eth", "description": "(Required) The network of a currency the client will receive" }, { "disabled": false, "key": "amount", "value": "0.2", "description": "(Required) The amount to be exchanged.\nMust be a positive number or a string representation of a positive number." }, { "disabled": false, "key": "fixed", "value": "false", "description": "Set this parameter to `true` to request fixed-rate pairs, or to `false` to request floating-rate pairs." }, { "disabled": false, "key": "reverse", "value": "false", "description": "Set to `true` to calculate the exchange based on the desired receive amount instead of the send amount." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e0f348cd-8c82-4ed8-9227-9dfeac6ce33c", "originalRequest": { "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "amount", "value": "0.2" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"canCreate\": true\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1adc19b-b057-4e57-8703-72246c9dbef5", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "amount", "value": "0.2" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e7fbd53-00d1-4c0a-a646-0be948608aa9", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "amount", "value": "0.2" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db44e6d7-99ae-4a9f-8745-977fda7b8af6", "name": "Pair not found", "originalRequest": { "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "amount", "value": "0.2" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8298337f-07ad-4f79-9995-184f7c8a42f0", "name": "Amount is out of range", "originalRequest": { "url": { "path": [ "v3", "exchanges", "check" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "tickerFrom", "value": "btc" }, { "key": "networkFrom", "value": "btc" }, { "key": "tickerTo", "value": "eth" }, { "key": "networkTo", "value": "eth" }, { "key": "amount", "value": "0.2" }, { "key": "fixed", "value": "false" }, { "key": "reverse", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6b6ede5-c84b-4c5f-8a6b-d8930cc76d46", "name": "Get exchange", "request": { "name": "Get exchange", "description": { "content": "Returns detailed information about a specific exchange identified by its unique exchange ID.\n\nThis endpoint provides the current state of the exchange, including its status, involved currencies, amounts, and other relevant details required to track the exchange lifecycle.\n\nThis endpoint is typically used to:\n- Retrieve the current status of an exchange\n- Track exchange progress and completion\n- Display exchange details to the user after creation\n\nNotes\n- Exchange status may change over time as the exchange is processed.\n- Clients are expected to poll this endpoint to track status updates.\n- The frequency of requests should be reasonable to avoid unnecessary load.", "type": "text/plain" }, "url": { "path": [ "v3", "exchanges", ":publicId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "publicId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f4867d5d-63f1-42f7-a955-1edb52187112", "originalRequest": { "url": { "path": [ "v3", "exchanges", ":publicId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "publicId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"publicId\": \"string\",\n \"type\": \"floating\",\n \"status\": \"expired\",\n \"tickerFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkFrom\": \"string\",\n \"networkTo\": \"string\",\n \"amountFrom\": \"string\",\n \"amountTo\": \"string\",\n \"addressFrom\": \"string\",\n \"extraIdFrom\": \"string\",\n \"addressTo\": \"string\",\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"txFrom\": \"string\",\n \"txTo\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"validUntil\": \"string\",\n \"currencies\": {\n \"currencyFrom\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n \"currencyTo\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n }\n }\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09634646-05b5-49fd-b4cb-fd514e63d99b", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "exchanges", ":publicId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "publicId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d128f8-651a-4c30-ac98-e0636e045ad9", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "exchanges", ":publicId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "publicId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79288e0f-b659-45fb-bd51-5c0729dbfdf6", "name": "Exchange not found", "originalRequest": { "url": { "path": [ "v3", "exchanges", ":publicId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "publicId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15581a8e-a9a3-4af7-a982-3ff842fe6bdb", "name": "Get exchanges", "request": { "name": "Get exchanges", "description": { "content": "Returns a list of exchanges associated with the current partner.\n\nThis endpoint provides summary information for multiple exchanges, allowing clients to retrieve exchange history and track multiple exchanges at once.\n\nThis endpoint is typically used to:\n- Display exchange history\n- Monitor the status of multiple exchanges\n- Build dashboards and reporting tools\n\nNotes\n- The list may be paginated depending on request parameters.\n- Results are returned in reverse chronological order by default.\n- The amount of data returned is limited to prevent excessive payload sizes.", "type": "text/plain" }, "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "100", "description": "Limit of transactions to return (default: 100) Note: You can only specify limit bigger than 0 and less than 1000" }, { "disabled": false, "key": "offset", "value": "0", "description": "Number of transactions to skip (default: 0) Note: You can only specify offset bigger than 0" }, { "disabled": false, "key": "startDate", "value": "2026-04-28T10:33:10.040Z", "description": "Minimum display date (empty by default). Date format must be ISO 8601. ('2000-01-01' or '2000-01-01T00:00:00Z')" }, { "disabled": false, "key": "finishDate", "value": "2026-05-05T10:33:10.041Z", "description": "Maximum date to display (empty by default). Date format must be ISO 8601. ('2000-01-01' or '2000-01-01T00:00:00Z')" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "30ba4c89-325e-4e86-8cf6-9a1c37cfea4d", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "startDate", "value": "2026-04-28T10:33:10.040Z" }, { "key": "finishDate", "value": "2026-05-05T10:33:10.041Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": [\n {\n \"publicId\": \"string\",\n \"type\": \"fixed\",\n \"status\": \"waiting\",\n \"tickerFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkFrom\": \"string\",\n \"networkTo\": \"string\",\n \"amountFrom\": \"string\",\n \"amountTo\": \"string\",\n \"addressFrom\": \"string\",\n \"extraIdFrom\": \"string\",\n \"addressTo\": \"string\",\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"txFrom\": \"string\",\n \"txTo\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"validUntil\": \"string\",\n \"currencies\": {\n \"currencyFrom\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n \"currencyTo\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n }\n }\n },\n {\n \"publicId\": \"string\",\n \"type\": \"floating\",\n \"status\": \"expired\",\n \"tickerFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkFrom\": \"string\",\n \"networkTo\": \"string\",\n \"amountFrom\": \"string\",\n \"amountTo\": \"string\",\n \"addressFrom\": \"string\",\n \"extraIdFrom\": \"string\",\n \"addressTo\": \"string\",\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"txFrom\": \"string\",\n \"txTo\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"validUntil\": \"string\",\n \"currencies\": {\n \"currencyFrom\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n \"currencyTo\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n }\n }\n }\n ],\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fda03897-1f4b-4ad4-8e93-c3d45ff1e733", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "startDate", "value": "2026-04-28T10:33:10.040Z" }, { "key": "finishDate", "value": "2026-05-05T10:33:10.041Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de812647-b2e0-4f15-843e-551e4ee5873a", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "startDate", "value": "2026-04-28T10:33:10.040Z" }, { "key": "finishDate", "value": "2026-05-05T10:33:10.041Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "368a664f-582f-49b2-9b97-14947953f5a9", "name": "Create exchange", "request": { "name": "Create exchange", "description": { "content": "Creates a new exchange transaction based on the provided parameters.\n\nThis endpoint is used to initiate an exchange between two currencies and returns detailed information about the created exchange, including its unique identifier and initial status.\n\nThe exchange can be created using either a floating or fixed rate and may be based on either the send amount or the desired receive amount, depending on the request parameters.\n\nThis endpoint is typically used to:\n- Validate the currency pair using the pairs endpoint\n- Check the allowed amount range\n- Request an exchange estimate\n\nNotes\n- The exchange status may change asynchronously after creation.\n- Final exchange results may vary due to market conditions and network fees.\n- For fiat exchanges, the server returns a redirectUrl that must be opened by the client to finalize the exchange.\n", "type": "text/plain" }, "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "44620892-6021-4eb4-b5ad-568cf5df4697", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"publicId\": \"string\",\n \"type\": \"floating\",\n \"status\": \"refunded\",\n \"tickerFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkFrom\": \"string\",\n \"networkTo\": \"string\",\n \"amountFrom\": \"string\",\n \"amountTo\": \"string\",\n \"addressFrom\": \"string\",\n \"extraIdFrom\": \"string\",\n \"addressTo\": \"string\",\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"txFrom\": \"string\",\n \"txTo\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"validUntil\": \"string\",\n \"currencies\": {\n \"currencyFrom\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n },\n \"currencyTo\": {\n \"name\": \"Ethereum\",\n \"ticker\": \"eth\",\n \"network\": \"eth\",\n \"legacySymbol\": \"eth\",\n \"contractAddress\": \"string\",\n \"hasExtraId\": false,\n \"extraId\": \"string\",\n \"image\": \"https://static.simpleswap.io/images/currencies-logo/eth.svg\",\n \"warningsFrom\": [\n \"Please be careful not to deposit your ETH from a smart contract.\"\n ],\n \"warningsTo\": [\n \"Please be careful not to provide a smart contract as your ETH payout address.\"\n ],\n \"validationAddress\": \"^(0x)[0-9A-Fa-f]{40}$\",\n \"validationExtra\": \"string\",\n \"addressExplorer\": \"https://etherscan.io/address/{}\",\n \"txExplorer\": \"https://etherscan.io/tx/{}\",\n \"confirmationsFrom\": \"string\",\n \"isFiat\": true,\n \"isAvailableFloat\": true,\n \"isAvailableFixed\": true,\n \"precision\": 18\n }\n }\n },\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2f58a5-b22b-4fe7-b5f5-359e670c014d", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d7fd7f-f107-409f-a024-cbfe49f2c3bc", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab787f83-b4e1-4b73-9ae5-d9a8a7cd3cee", "name": "Pair not found", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"error\": \"Not Found\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45463fc-ed9f-4821-9ea5-065679394ade", "name": "Amount is out of range", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "disabled": false, "description": "Client user agent", "key": "x-user-agent", "value": "string" }, { "disabled": false, "description": "Client language", "key": "x-user-language", "value": "string" }, { "disabled": false, "description": "Client timezone", "key": "x-user-timezone", "value": "string" }, { "disabled": false, "description": "Client device OS", "key": "x-device-os", "value": "string" }, { "disabled": false, "description": "Client IP", "key": "x-client-ip", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tickerFrom\": \"btc\",\n \"networkFrom\": \"btc\",\n \"tickerTo\": \"eth\",\n \"networkTo\": \"eth\",\n \"amount\": \"0.2\",\n \"addressTo\": \"string\",\n \"fixed\": false,\n \"reverse\": false,\n \"customFee\": null,\n \"extraIdTo\": \"string\",\n \"userRefundAddress\": \"string\",\n \"userRefundExtraId\": \"string\",\n \"rateId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ea8e9ec-f423-47c8-8b62-884ebc7869e9", "name": "Confirm exchange", "request": { "name": "Confirm exchange", "description": { "content": "Confirms that the deposit for an exchange has already been sent by the client.\n\nThis endpoint is used to notify the system that the user has completed the deposit, allowing the exchange to be processed without waiting for automatic detection.\n\nCalling this endpoint can help speed up exchange processing, especially in cases where the deposit has already been made and network confirmation is pending.\n\nThis endpoint is typically used to:\n- Accelerate exchange processing after the deposit is sent\n- Manually confirm user action in client applications\n- Reduce waiting time caused by delayed deposit detection\n\nNotes\n- This endpoint does not create a new exchange.\n- Confirmation does not guarantee immediate completion of the exchange.\n- The exchange will still be processed according to network confirmation rules.", "type": "text/plain" }, "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"publicId\": \"string\",\n \"txFrom\": \"string\",\n \"providerUserDepositAddress\": \"string\",\n \"targetAddress\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0b49613-9c25-4d02-a9a2-75dbce2d9c30", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"publicId\": \"string\",\n \"txFrom\": \"string\",\n \"providerUserDepositAddress\": \"string\",\n \"targetAddress\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {},\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c3d6856-4eee-44e6-8695-fa569e60dfc0", "name": "Request parameters are not valid", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"publicId\": \"string\",\n \"txFrom\": \"string\",\n \"providerUserDepositAddress\": \"string\",\n \"targetAddress\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e45285-96e4-4076-90ab-efec9edf0425", "name": "Wrong api key", "originalRequest": { "url": { "path": [ "v3", "exchanges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"publicId\": \"string\",\n \"txFrom\": \"string\",\n \"providerUserDepositAddress\": \"string\",\n \"targetAddress\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"string\",\n \"traceId\": \"00000000-0000-0000-0000-000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "02220b61-501f-4898-a88b-f8ccd5673761", "name": "Market", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e482dca7-05f3-4201-bcac-8b3c86bb2b53", "name": "Get exchange markets", "request": { "name": "Get exchange markets", "description": { "content": "Returns a consolidated list of exchange pairs with their available ranges and current rate estimates.\n \nAccess to this endpoint is restricted. Please contact [partnerships@simpleswap.io](mailto:partnerships@simpleswap.io) to request access.", "type": "text/plain" }, "url": { "path": [ "v3", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fixed", "value": "false", "description": "Set this parameter to `true` to request fixed-rate pairs, or to `false` to request floating-rate pairs." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b4e5f93e-f33b-4107-8485-ade3ce62bb2b", "originalRequest": { "url": { "path": [ "v3", "market" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fixed", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": [\n {\n \"tickerFrom\": \"string\",\n \"networkFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkTo\": \"string\",\n \"min\": \"string\",\n \"max\": \"string\",\n \"rate\": \"string\",\n \"minerFee\": \"string\",\n \"reserve\": \"string\",\n \"untilTime\": \"string\",\n \"rateId\": \"string\"\n },\n {\n \"tickerFrom\": \"string\",\n \"networkFrom\": \"string\",\n \"tickerTo\": \"string\",\n \"networkTo\": \"string\",\n \"min\": \"string\",\n \"max\": \"string\",\n \"rate\": \"string\",\n \"minerFee\": \"string\",\n \"reserve\": \"string\",\n \"untilTime\": \"string\",\n \"rateId\": \"string\"\n }\n ],\n \"traceId\": \"00000000-0000-0000-0000-0000000000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.simpleswap.io", "key": "baseUrl" }, { "key": "apiKey", "value": "YOUR_API_KEY", "type": "string" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "669b0695-4d28-41c5-9acf-619746a7573f", "name": "Public-API V3 | API documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Provided by [https://simpleswap.io](https://simpleswap.io)\n\nCurrently, the **rate limit** for Public API is 50 requests per 10 seconds. \nExceeding the number of requests will result in IP blocking for 1 minute. \nTo increase the number of requests, please contact us via email on [partnerships@simpleswap.io](mailto:partnerships@simpleswap.io)\n", "type": "text/plain" } } }