> For the complete documentation index, see [llms.txt](https://coinsdo.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coinsdo.gitbook.io/docs/general/coinsdo-open-api/coinget.md).

# CoinGet

Get receiving address

Retrieve receiving address from address pool.

<mark style="color:green;">`POST`</mark> `/v1/addressGet`

### **Request**&#x20;

<table><thead><tr><th width="99.5546875">Parameter</th><th width="99.7421875">Required</th><th width="80.16015625">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content（JSON string，refer below）</td></tr></tbody></table>

```json
{
  "apiKey": "cd384rt80f5575dc",
  "mainnet": "TRX",
  "targetDeviceUuid": "085C28EC-0BD6-442B-8232-D23BC8F4D58E",
  "timestamp": "1622775712229",
  "addressRemark": "trx address"
}
```

* Data parameter

<table><thead><tr><th width="160.2734375">Parameter</th><th width="100.09765625">Required</th><th width="90.41015625">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API Key</td></tr><tr><td>mainnet</td><td>Yes</td><td>String</td><td>Network code, refer to <a href="https://coinsdo.gitbook.io/docs/general/coinsdo-open-api/general#supported-networks">Supported Networks</a><a href="https://coinsdo.gitbook.io/docs/general/coinsdo-open-api/general#supported-networks">.</a></td></tr><tr><td>targetDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet device UUID</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp (seconds or milliseconds)</td></tr><tr><td>addressRemark</td><td>No</td><td>String</td><td>Address remarks</td></tr><tr><td>isConvert</td><td>No</td><td>String</td><td>Do you want to convert the address? <br>0. No - default<br>1. Yes, only used by BCH currently to convert to legacy address)</td></tr></tbody></table>

**Request example 1**

```json
{
    "data": "{\"apiKey\":\"cd384rt80f5575dc\",\"mainnet\":\"TRX\",\"targetDeviceUuid\":\"085C28EC-0BD6-442B-8232-D23BC8F4D58E\",\"timestamp\":\"1622775712229\",\"addressRemark\":\"trx address\"}",
    "sign": "67355f9ad0db846edd05761462edfc1f8d396af2624e8998ee52c010c7a60dbd"
}
```

**Request example 2**

```json
{
    "data":"{\"mainnet\":\"BCH\",\"targetDeviceUuid\":\"92E30E38-63A1-41DC-B95C-8E729DFDDE7A\",\"apiKey\":\"4c90b98cc97b45b2\",\"isConvert\":\"1\",\"timestamp\":2639477935817}",
    "sign":"7d9ae0b10068422ff30be92f45bdda0fe69bf405224564cefdc81775241d4081"
}
```

**Response example 1**

```json
{
  "code": 200, // Status code
  "msg": "Success", // Remarks
  "data": {
    "address": "TKU69qcQPoR5jDEE7ertPpdaxoLGCTX4xR",
    "addrSign": "TESTTESTU4u0dj5xXEoZ9E4EXSes9WawqfpxrRfOIHgXV1BnPNM2tt0DLloCnJkzR7smC26+z6kuZb87s3hitZWgM3UaWWghB8/qNMQImvCZ6MREqChoNmEVyaqCnTbjorKsrU/V0=",
    "convertedAddr": null
  }
}
```

**Response example 2**

```json
{
  "code": 200,
  "msg": "Success",
  "data": {
    "address": "bchtest:qzfr5996z72me99flf32jf6yfs38hshcwcp3dx8eja",
    "addrSign": "ZJA+/GJGNUXFw2soBGBaEbWFSOPtNMD8eRdVLTyZyuKHjnyklWvGe8SqkV8xxhwlFcT1+td9AbKstLD6b+lJ4jSCIqm5WbcMJjo0k1mCdihAagsbn5zVyTYEO7LQac341wP/76jopdYnH/yVvP5VtcNq8ZgkrcOi08ReLaQsMO8=",
    "convertedAddr": "mtr8XbbzhJVG2TYy3bYFxfV5TBw8PSEzkB"
  }
}

```

* Data content

<table><thead><tr><th width="139.61328125">Parameter</th><th width="100.39453125">Required</th><th width="90.16015625">Type</th><th>Description</th></tr></thead><tbody><tr><td>address</td><td>Yes</td><td>String</td><td>Receiving address</td></tr><tr><td>addrSign</td><td>Yes</td><td>String</td><td>Receiving address signature (Verify address through CoinGet’s public key)</td></tr><tr><td>convertedAddr</td><td>No</td><td>String</td><td>Converted address (Currently only BCH can be changed to legacy address, a string of your address will be returned for callback, callback will only be based on address parameter)</td></tr></tbody></table>

**Response Status**

<table><thead><tr><th width="119.375">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4042</td><td>Failed to verify collection wallet</td></tr><tr><td>4043</td><td>Collection wallet does not exist</td></tr><tr><td>4044</td><td>Failed to receive collection address</td></tr><tr><td>4045</td><td>Insufficient addresses</td></tr><tr><td>4050</td><td>Currently does not support this mainnet</td></tr><tr><td>4051</td><td>EOS chain does not require a collection address</td></tr><tr><td>4052</td><td>Token does not require a collection address</td></tr><tr><td>4053</td><td>Failed to convert BCH address</td></tr><tr><td>4061</td><td>Failed to verify linked records</td></tr><tr><td>4062</td><td>Unable to generate address from a linked mainnet</td></tr><tr><td>4063</td><td>Failed to verify gas fee address</td></tr><tr><td>4064</td><td>Mainnet not supported by your dispatch wallet. Please update your dispatch wallet</td></tr><tr><td>4071</td><td>Select a mainnet</td></tr><tr><td>4072</td><td>Failed to verify mainnet</td></tr></tbody></table>

***

## Convert BCH address <a href="#bch-converting-address" id="bch-converting-address"></a>

Convert BCH Legacy address to Cash address

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/bchAddrConvert`

<table><thead><tr><th width="109.9375">Parameter</th><th width="99.5859375">Required</th><th width="80.06640625">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content（JSON string, refer below）</td></tr></tbody></table>

```json
{
  "apiKey": "4c90b98cc97b45b2",
  "address": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
  "timestamp": "2639474345487"
}
```

* data content

<table><thead><tr><th width="110.14453125">Parameter</th><th width="89.5234375">Required</th><th width="79.71875">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API Key</td></tr><tr><td>address</td><td>Yes</td><td>String</td><td>BCH address，Legacy (classic) and CashAddr (Standard)</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp(seconds or milliseconds)</td></tr></tbody></table>

**Request example 1**

```json
{
  "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s\",\"timestamp\":\"2639474345487\"}",
  "sign":"fc2ed2d7713a499ff718e69507cb95b1a49ac00f4be1daf34187381b8afc43c9"
}
```

**Request example 2**

```json
{
  "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca\",\"timestamp\":\"2639474345487\"}",
  "sign":"7acecc69f1b8c05be5ebfc8435d9fea0cf39aa9138af22084f3a9aa96b323844"
}
```

### **Response**

**Response example 1**

```json
{
  "code": 200,
  "msg": "success",
  "data": {
    "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
    "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
  }
}
```

**Response example 2**

```json
{
  "code": 200,
  "msg": "success",
  "data": {
    "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
    "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
  }
}
```

* data parameters

<table><thead><tr><th width="110.03515625">Parameter</th><th width="99.7734375">Required</th><th width="89.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>legacyAddr</td><td>Yes</td><td>String</td><td>Legacy format (classic address)</td></tr><tr><td>cashAddr</td><td>Yes</td><td>String</td><td>CashAddr format (Standard address)</td></tr></tbody></table>

**Response status**

<table><thead><tr><th width="110.078125">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4053</td><td>Failed to convert BCH address</td></tr><tr><td>4054</td><td>Wrong format for BCH address</td></tr><tr><td>4055</td><td>Failed to verify BCH address</td></tr></tbody></table>

***

## Token sweep <a href="#manual-collection" id="manual-collection"></a>

Trigger token sweep on specific address

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/manualCollect`

<table><thead><tr><th width="109.6484375">Parameter</th><th width="99.98828125">Required</th><th width="80.2578125">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content（JSON string，refer to below）</td></tr></tbody></table>

```json
{
    "apiKey": "4c90b98cc97b45b2",
    "address": "0xd065380c78847bfba75ad158067a5e8e845205f0",
    "coinsDoId": "22",
    "collectAmount": "0.12",
    "timestamp": "1671699594204"
}
```

* Data content

<table><thead><tr><th width="134.9765625">Parameter</th><th width="99.9296875">Require</th><th width="85.31640625">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API KEY</td></tr><tr><td>address</td><td>Yes</td><td>String</td><td>Receiving address</td></tr><tr><td>coinsDoId</td><td>Yes</td><td>String</td><td>CoinsDo assigned Token ID(Refer to token list)</td></tr><tr><td>collectAmount</td><td>No</td><td>String</td><td>Collection amount(will collect all available balance if not filled)</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp (in seconds or milliseconds)</td></tr></tbody></table>

**Request example 1**

```json
{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"timestamp\":\"1671698862478\"}",
    "sign":"bca9130ebc1998e2fea8c81bf480f13dbdd7259f05ac7019f47a70bc8bae407f"
}
```

**Request example 2**

```json
{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"collectAmount\":\"0.12\",\"timestamp\":\"1671699594204\"}",
    "sign":"278682f15ae9afba34566b79eb26d90b1ba5d5542f53a2a6b650542265aac429"
}
```

### **Response**

**Response example**

```json
{
    "code": 200, // status code
    "msg": "成功", // message
    "data": null // response data
}
```

**Response status code**

<table><thead><tr><th width="139.5">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4066</td><td>Failed to verify supported tokens</td></tr><tr><td>4073</td><td>CoinsDoId does not exist</td></tr><tr><td>4074</td><td>Receiving address does not exist</td></tr><tr><td>4075</td><td>Wallet version not supported</td></tr><tr><td>4076</td><td>Insufficient balance</td></tr><tr><td>4077</td><td>Existing collections not yet complete</td></tr><tr><td>4078</td><td>Wallet collection switch not turned on</td></tr><tr><td>4079</td><td>Failed to save manual collection record</td></tr><tr><td>4080</td><td>Failed to query minimum balance configuration</td></tr><tr><td>4081</td><td>Failed to query manual collection record</td></tr><tr><td>4082</td><td>Collection amount should be greater than 0</td></tr></tbody></table>

***

## Get address balance <a href="#get-balance" id="get-balance"></a>

Retrieve address balance info

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/balanceGet`

<table><thead><tr><th width="109.7109375">Parameter</th><th width="100.16015625">Required</th><th width="79.85546875">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content（JSON string，refer to below）</td></tr></tbody></table>

```json
{
    "apiKey": "d3a0beaa70474d3b",
    "addresses": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
    "coinsDoId": "30",
    "timestamp": 1679397493762
}
```

* Data content

<table><thead><tr><th width="109.984375">Parameter</th><th width="99.6171875">Required</th><th width="80.11328125">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API KEY</td></tr><tr><td>addresses</td><td>Yes</td><td>String</td><td>Receiving address (maximum of 1000 addresses)</td></tr><tr><td>coinsDoId</td><td>Yes</td><td>String</td><td>CoinsDo assigned Token ID (Refer to token list)</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp (in seconds or milliseconds)</td></tr></tbody></table>

**Request example**

```json
{
  "data": "{\"addresses\":[\"0x2EFCDD48E44A82CEE87DF6B6DD9649AA9A758CB4\",\"0xE0FEB0AAF65FF5162CE3B7F8FD52B9166BF27616\"],\"apiKey\":\"06cc38296ecc4602\",\"coinsDoId\":\"2\",\"timestamp\":1763977264}",
  "sign":"5d1fc48506b4dd304fe28603ae827fe4cd08772d9307bf5700fd15ba366de751"
}
```

### **Response**

**Response example**

```json
{
    "success": true,
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
            "balance": "15.123456789012345678",
            "balanceUpdateTime": "1669712411"
        },
        {
            "address": "rN7n7otQDd6FczFgLdM83BjW4GCdgRAWjU",
            "balance": "1.0009702640000000",
            "balanceUpdateTime": "1669712500"
        },
        {
            "address": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
            "balance": "1000.500000000000000000",
            "balanceUpdateTime": "1669712600"
        }
    ]
}
```

* Data parameter

<table><thead><tr><th width="179.84765625">Parameter</th><th width="99.77734375">Required</th><th width="80.12890625">Type</th><th>Description</th></tr></thead><tbody><tr><td>address</td><td>Yes</td><td>String</td><td>Receiving address</td></tr><tr><td>balance</td><td>Yes</td><td>String</td><td>receiving address’ balance</td></tr><tr><td>balanceUpdateTime</td><td>Yes</td><td>String</td><td>Transaction confirmation timestamp(seconds)</td></tr></tbody></table>

**Response status**

<table><thead><tr><th width="114.5859375">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4002</td><td>JSON parsing error</td></tr><tr><td>4003</td><td>APIKEY does not exist</td></tr><tr><td>4005</td><td>IP restricted, current IP:</td></tr><tr><td>4007</td><td>Signature verification failed</td></tr><tr><td>4010</td><td>Request expired</td></tr><tr><td>4034</td><td>Failed to verify address</td></tr><tr><td>4066</td><td>Failed to verify supported tokens</td></tr><tr><td>4073</td><td>CoinsDoId does not exist</td></tr><tr><td>4074</td><td>Receiving address does not exist</td></tr><tr><td>4099</td><td>Too many requests</td></tr></tbody></table>

***

## Get collection statistics <a href="#get-collection-statistics" id="get-collection-statistics"></a>

Retrieve gas fee address statistics

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/collectStatistic`

<table><thead><tr><th width="109.9375">Parameter</th><th width="99.5859375">Required</th><th width="80.06640625">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content (JSON string, as shown below)</td></tr></tbody></table>

```json
{
    "apiKey": "7bb52d79e46e47ab",
    "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
    "startTime": "1738886400",
    "endTime": "1738943999",
    "timestamp": "1740379248"
}
```

* data content

<table><thead><tr><th width="163.6796875">Parameter</th><th width="89.5234375">Required</th><th width="79.71875">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API Key</td></tr><tr><td>depositDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet device UUID</td></tr><tr><td>startTime</td><td>Yes</td><td>String</td><td>Start time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)</td></tr><tr><td>endTime</td><td>Yes</td><td>String</td><td>End time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp (seconds or milliseconds)</td></tr></tbody></table>

**Request example**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **Response**

**Response example**

```json
{
    "code": 200,
    "msg": "Success",
    "success": true,
    "data": {
        "deviceName": "alpha",
        "deviceRemark": "Pixel 7-5be6",
        "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
        "details": [
            {
              "chain": "ADA",
              "currency": "ADA",
              "currencyName": "ADA",
              "flag": "ADA",
              "customName": "ADA",
              "collectedAmount": 0,
              "uncollectedAmount": 0,
              "lastUpdateTime": null,
              "currencyType": 0
            },
            {
              "chain": "ALGO",
              "currency": "ALGO",
              "currencyName": "ALGO",
              "flag": "ALGO",
              "customName": "ALGO",
              "collectedAmount": 0,
              "uncollectedAmount": 0,
              "lastUpdateTime": null,
              "currencyType": 0
            }
        ]
    }
}
```

* data parameters

<table><thead><tr><th width="166.8671875">Parameter</th><th width="99.7734375">Required</th><th width="89.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>deviceName</td><td>Yes</td><td>String</td><td>CoinGet client name</td></tr><tr><td>deviceRemark</td><td>Yes</td><td>String</td><td>CoinGet client remark</td></tr><tr><td>depositDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet client UUID</td></tr><tr><td>details</td><td>Yes</td><td>Array</td><td>Collection statistics</td></tr></tbody></table>

* detail parameters

<table><thead><tr><th width="178.6484375">Parameter</th><th width="99.7734375">Required</th><th width="89.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>chain</td><td>Yes</td><td>String</td><td>Mainnet</td></tr><tr><td>currency</td><td>Yes</td><td>String</td><td>Coin name/protocol</td></tr><tr><td>currencyName</td><td>Yes</td><td>String</td><td>Coin name</td></tr><tr><td>flag</td><td>Yes</td><td>String</td><td>Token address</td></tr><tr><td>customName</td><td>No</td><td>String</td><td>Coin custom name</td></tr><tr><td>collectedAmount</td><td>Yes</td><td>Decimal</td><td>Collected amount</td></tr><tr><td>uncollectedAmount</td><td>Yes</td><td>Decimal</td><td>Uncollected amount</td></tr><tr><td>lastUpdateTime</td><td>No</td><td>String</td><td>Last update time</td></tr><tr><td>currencyType</td><td>Yes</td><td>Integer</td><td>Coin type:<br>0. Native coin<br>1. Non-native coin</td></tr></tbody></table>

**Response status**

<table><thead><tr><th width="110.078125">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4002</td><td>Invalid parameter format</td></tr><tr><td>4003</td><td>JSON parsing error</td></tr><tr><td>4004</td><td>APIKEY does not exist</td></tr><tr><td>4005</td><td>IP restricted, current IP:</td></tr><tr><td>4007</td><td>Signature verification failed</td></tr><tr><td>4010</td><td>Request expired</td></tr><tr><td>4032</td><td>Wallet query failed</td></tr><tr><td>4068</td><td>Failed to validate API Key</td></tr><tr><td>4099</td><td>Too many requests</td></tr><tr><td>4116</td><td>The selected time range is outside the allowed limit</td></tr><tr><td>4118</td><td>Failed to retrieve currency control settings</td></tr><tr><td>4119</td><td>Failed to query supported coin list</td></tr><tr><td>4120</td><td>Failed to query collection statistics</td></tr><tr><td>4123</td><td>Start time cannot be after the end time</td></tr><tr><td>4124</td><td>Time range cannot cross calendar days</td></tr></tbody></table>

***

## Get collection gas fee statistics <a href="#get-collection-gas-fee-statistics" id="get-collection-gas-fee-statistics"></a>

Retrieve collection gas fee statistics

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/collectStatisticFee`

<table><thead><tr><th width="109.9375">Parameter</th><th width="99.5859375">Required</th><th width="80.06640625">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content (JSON string, as shown below)</td></tr></tbody></table>

```json
{
    "apiKey": "7bb52d79e46e47ab",
    "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
    "startTime": "1738886400",
    "endTime": "1738943999",
    "timestamp": "1740379248"
}
```

* data content

<table><thead><tr><th width="163.6796875">Parameter</th><th width="89.5234375">Required</th><th width="79.71875">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API Key</td></tr><tr><td>depositDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet device UUID</td></tr><tr><td>startTime</td><td>Yes</td><td>String</td><td>Start time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)</td></tr><tr><td>endTime</td><td>Yes</td><td>String</td><td>End time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)</td></tr><tr><td>timestamp</td><td>Yes</td><td>String</td><td>Timestamp (seconds or milliseconds)</td></tr></tbody></table>

**Request example**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **Response**

**Response example**

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": {
        "depositDeviceUuid": "3813AC47-AB3C-4510-AFA9-47D7BDC23C37",
        "deviceName": "main",
        "deviceRemark": "",
        "details": [
            {
                "chain": "AMB",
                "currency": "AMB",
                "currencyName": "AMB",
                "flag": "AMB",
                "customName": null,
                "usedFeeAmount": 0,
                "unusedFeeAmount": 0,
                "lastUpdateTime": null,
                "currencyType": 0
            },
            {
                "chain": "ARB1",
                "currency": "ARB1",
                "currencyName": "ARB1",
                "flag": "ARB1",
                "customName": null,
                "usedFeeAmount": 0,
                "unusedFeeAmount": 0,
                "lastUpdateTime": null,
                "currencyType": 0
            }
        ]
    }
}
```

* data parameters

<table><thead><tr><th width="166.8671875">Parameter</th><th width="99.7734375">Required</th><th width="89.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>deviceName</td><td>Yes</td><td>String</td><td>CoinGet client name</td></tr><tr><td>deviceRemark</td><td>Yes</td><td>String</td><td>CoinGet client remark</td></tr><tr><td>depositDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet client UUID</td></tr><tr><td>details</td><td>Yes</td><td>Array</td><td>Gas fee address statistics</td></tr></tbody></table>

* detail parameters

<table><thead><tr><th width="178.6484375">Parameter</th><th width="99.7734375">Required</th><th width="89.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>chain</td><td>Yes</td><td>String</td><td>Mainnet</td></tr><tr><td>currency</td><td>Yes</td><td>String</td><td>Coin name/protocol</td></tr><tr><td>currencyName</td><td>Yes</td><td>String</td><td>Coin name</td></tr><tr><td>flag</td><td>Yes</td><td>String</td><td>Token address</td></tr><tr><td>customName</td><td>No</td><td>String</td><td>Coin custom name</td></tr><tr><td>usedFeeAmount</td><td>Yes</td><td>Decimal</td><td>Used gas fee amount</td></tr><tr><td>unusedFeeAmount</td><td>Yes</td><td>Decimal</td><td>Unused gas fee amount</td></tr><tr><td>lastUpdateTime</td><td>No</td><td>String</td><td>Last update time</td></tr><tr><td>currencyType</td><td>Yes</td><td>Integer</td><td>Coin type:<br>0. Native coin<br>1. Non-native coin</td></tr></tbody></table>

**Response status**

<table><thead><tr><th width="110.078125">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4002</td><td>Invalid parameter format</td></tr><tr><td>4003</td><td>JSON parsing error</td></tr><tr><td>4004</td><td>APIKEY does not exist</td></tr><tr><td>4005</td><td>IP restricted, current IP:</td></tr><tr><td>4007</td><td>Signature verification failed</td></tr><tr><td>4010</td><td>Request expired</td></tr><tr><td>4032</td><td>Wallet query failed</td></tr><tr><td>4068</td><td>Failed to validate API Key</td></tr><tr><td>4099</td><td>Too many requests</td></tr><tr><td>4116</td><td>The selected time range is outside the allowed limit</td></tr><tr><td>4118</td><td>Failed to retrieve currency control settings</td></tr><tr><td>4119</td><td>Failed to query supported coin list</td></tr><tr><td>4121</td><td>Failed to query collected gas fee address statistics</td></tr><tr><td>4123</td><td>Start time cannot be after the end time</td></tr><tr><td>4124</td><td>Time range cannot cross calendar days</td></tr></tbody></table>

***

## Get Receiving Record <a href="#get-receiving-record" id="get-receiving-record"></a>

Retrieve receiving record info

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/depositRecordPageGet`

<table><thead><tr><th width="109.7109375">Parameter</th><th width="100.16015625">Required</th><th width="79.85546875">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>String</td><td>Content (JSON string, as shown below)</td></tr></tbody></table>

```json
{
    "apiKey": "aa465953d55641b3",
    "timestamp": 2622775712229,
    "pageNum": 1,
    "pageSize": 100,
    "startArrivalTime": 1763913600000,
    "endArrivalTime": 1763999999000
}
```

* Data parameter

<table><thead><tr><th width="160.2734375">Parameter</th><th width="100.09765625">Required</th><th width="90.41015625">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>String</td><td>API Key</td></tr><tr><td>timestamp</td><td>Yes</td><td>Integer</td><td>Timestamp (in seconds or milliseconds)</td></tr><tr><td>pageNum</td><td>No</td><td>Integer</td><td>Current page number (cannot be less than 1)</td></tr><tr><td>pageSize</td><td>No</td><td>Integer</td><td>Records per page (must be between 15 and 100)</td></tr><tr><td>startArrivalTime</td><td>Yes</td><td>Integer</td><td>Received start date and time (in milliseconds)</td></tr><tr><td>endArrivalTime</td><td>Yes</td><td>Integer</td><td>Received end date and time (in milliseconds)</td></tr></tbody></table>

**Request example**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"timestamp\":2622775712229,\"pageNum\":1,\"pageSize\":15,\"startArrivalTime\":1763913600000,\"endArrivalTime\":1763999999000}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **Response**

**Response example**

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPageCount": 1,
        "totalRowCount": 10,
        "results": [
            {
                "merchantId": 4636267787041793,
                "amount": "1.7007",
                "callBackStatus": 1,
                "createTime": "2025-11-24T08:15:30.071+00:00",
                "currency": "SPL",
                "depositDeviceUuid": "D9868C45-0D72-499E-991E-B5A6D7109EE8",
                "depositSign": "dKyj8t+oBFnw0VqZo7ZkGpHhXSUdafDQGjUhIXmMBgCTIeuE2ZJrB7JzxJcM6snirXk+ONoaEjY/df6zbOLvrmc5aC0G2/F8v/PCdP+3pieC1ahWBpyk0C0IAFwDJC6k10CQvs78M8qPo5wW9sms/51zWS5fLxVI/LYEPqPwPdY=",
                "depositType": 0,
                "flag": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
                "fromAddress": "8iWBzd4z8WoiknZXVfisu1pGAEkKVAp7KNaHrHREi1Wa",
                "ignoreCheck": 0,
                "toAddress": "FPTTusorT3br9KUy7uxF183f2rQ31nzov18JoBHpy3mY",
                "txHash": "2CvV1GaU69uadHiMmLSsGvuzdAo1XLTe2ZCtYaTQTdKG724LHs8cA7LtdhcAT9fyXRwdNsSg2ANC1i3PFQaFqaH1",
                "txIndex": 0,
                "txMemo": null,
                "txTime": "2025-11-24T08:15:04.000+00:00",
                "txFee": "0.00001"
            },
            {
                "merchantId": 4636267787041793,
                "amount": "1.7007",
                "callBackStatus": 1,
                "createTime": "2025-11-24T08:07:30.139+00:00",
                "currency": "SPL",
                "depositDeviceUuid": "D9868C45-0D72-499E-991E-B5A6D7109EE8",
                "depositSign": "XNrphXHtse7aRxFH31qJcgES1rQYmez5+OdEU4QuFHPBwbH9lTYjoP0KDwpPvvZbL7evmIEHyhQJBJxJ5n5YQxNswdkNTyA3GTJN/xNxsEcDzs5sb43d5aOe0tU/2+HuSHiOVpm1rBxSYXiIIuQRzTRaDFR9VwNzDtSWEEhyZhg=",
                "depositType": 0,
                "flag": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
                "fromAddress": "8iWBzd4z8WoiknZXVfisu1pGAEkKVAp7KNaHrHREi1Wa",
                "ignoreCheck": 0,
                "toAddress": "FPTTusorT3br9KUy7uxF183f2rQ31nzov18JoBHpy3mY",
                "txHash": "3WARL4k525S6r7ZPFBwVBoHwaMiGYhNiL4HvdiCfnSs5TDnA9q6nsi3gimz5nXkmDd2V3tbKLshtAVDUaKh7xSsq",
                "txIndex": 0,
                "txMemo": null,
                "txTime": "2025-11-24T08:06:52.000+00:00",
                "txFee": "0.00001"
            }
        ]
    }
}
```

* Data parameter

<table><thead><tr><th width="179.84765625">Parameter</th><th width="99.77734375">Required</th><th width="80.12890625">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchantId</td><td>Yes</td><td>Long</td><td>Corporate ID</td></tr><tr><td>amount</td><td>Yes</td><td>String</td><td>Received amount</td></tr><tr><td>callBackStatus</td><td>Yes</td><td>Integer</td><td>Received notice:<br>-1 - Callback not required<br>0 - Pending callback<br>1 - Callback successful<br>2 - Callback failed</td></tr><tr><td>createTime</td><td>Yes</td><td>String</td><td>Received time</td></tr><tr><td>currency</td><td>Yes</td><td>String</td><td>Coin name/protocol</td></tr><tr><td>depositDeviceUuid</td><td>Yes</td><td>String</td><td>CoinGet client UUID</td></tr><tr><td>depositSign</td><td>Yes</td><td>String</td><td>Receiver signature</td></tr><tr><td>depositType</td><td>Yes</td><td>Integer</td><td>Deposit type:<br>0 - Transfer<br>1 - Gas Fee Transfer<br>2 - Change</td></tr><tr><td>flag</td><td>Yes</td><td>String</td><td>Token address</td></tr><tr><td>fromAddress</td><td>Yes</td><td>String</td><td>Sender address</td></tr><tr><td>ignoreCheck</td><td>Yes</td><td>Integer</td><td>Ignore check:<br>0 - Not ignored<br>1 - Ignore</td></tr><tr><td>toAddress</td><td>Yes</td><td>String</td><td>Receiver address</td></tr><tr><td>txHash</td><td>Yes</td><td>String</td><td>Transaction hash</td></tr><tr><td>txIndex</td><td>Yes</td><td>Integer</td><td>Transaction sequence number</td></tr><tr><td>txMemo</td><td>Yes</td><td>String</td><td>On-chain remark</td></tr><tr><td>txTime</td><td>Yes</td><td>String</td><td>Transaction time</td></tr><tr><td>txFee</td><td>Yes</td><td>String</td><td>Gas fee</td></tr></tbody></table>

**Response status**

<table><thead><tr><th width="114.5859375">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4002</td><td>APIKEY cannot not be empty<br>sign cannot not be empty<br>Current page number cannot be less than 1<br>Records per page must be between 15 and 100<br>Timestamp cannot not be empty<br>Received start date and time cannot not be empty<br>Received end date and time cannot not be empty</td></tr><tr><td>4004</td><td>APIKEY does not exist</td></tr><tr><td>4007</td><td>Signature verification failed</td></tr><tr><td>4099</td><td>Too many requests</td></tr><tr><td>4010</td><td>Request expired</td></tr><tr><td>4163</td><td>The time range between the received start and end date and time cannot exceed 24 hours.</td></tr></tbody></table>

***

## Bulk add CoinGet tokens <a href="#bulk-add-coinget-tokens" id="bulk-add-coinget-tokens"></a>

To add multiple CoinGet tokens in bulk.

### **Request**

<mark style="color:green;">`POST`</mark> `/v1/addCoinGetToken`

<table data-full-width="false"><thead><tr><th width="171.24609375">Parameter</th><th width="99.65625">Required</th><th width="79.625">Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Yes</td><td>string</td><td>Content (JSON string, refer below)</td></tr></tbody></table>

```json
{
    "apiKey": "7bb52d79e46e47ab",
    "currencyList": [
    {
      "currency": "TRC20",
      "flag": "TTxkFx74d5k16nWnrfN7uy94pv3udyqbC8",
      "customName": "USDT",
      },
    {
      "currency": "ERC20",
      "flag": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
      "customName": "USDT"
    }
  ]
    "timestamp": "1740379248"
}
```

* Data content

<table data-full-width="false" data-search="true"><thead><tr><th width="171.24609375">Parameter</th><th width="99.65625">Required</th><th width="146.20703125">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>Yes</td><td>string</td><td>API Key</td></tr><tr><td>currencyList</td><td>Yes</td><td>Array&#x3C;Object></td><td>Token list (up to 10 tokens)</td></tr><tr><td>timestamp</td><td>Yes</td><td>string</td><td>Timestamp (seconds)</td></tr></tbody></table>

* currencyList Element Structure

<table data-full-width="false" data-search="true"><thead><tr><th width="171.24609375">Parameter</th><th width="99.65625">Required</th><th width="146.20703125">Type</th><th>Description</th></tr></thead><tbody><tr><td>currency</td><td>Yes</td><td>string</td><td>Token network protocol identifier<br>Example: TRC20</td></tr><tr><td>flag</td><td>Yes</td><td>string</td><td>Token address<br>Example: TTxkFx74d5k16nWnrfN7uy94pv3udyqbC8</td></tr><tr><td>customName</td><td>Yes</td><td>string</td><td>Token custom name<br>Example: USDT</td></tr><tr><td>needStar</td><td>No</td><td>boolean</td><td><p>true = Mark the token as a favourite.<br>false = Do not mark the token as a favourite.</p><p>Note: If <code>needStar</code> is not provided, the token will be marked as a favourite by default.</p></td></tr></tbody></table>

**Request example**

{% code fullWidth="false" %}

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"currencyList\":[{\"currency\":\"TRC20\",\"flag\":\"TTxkFx74d5k16nWnrfN7uy94pv3udyqbC8\",\"customName\":\"USDT\",\"needStar\":true},{\"currency\":\"ERC20\",\"flag\":\"0xdAC17F958D2ee523a2206206994597C13D831ec7\",\"customName\":\"USDT\",\"needStar\":true}],\"timestamp\":\"1740379248\"",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

{% endcode %}

### **Response**

{% code fullWidth="false" %}

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": {
        "total": 2,
        "successCount": 1,
        "failCount": 1,
        "failList": [
            {
                "currency": "ERC20",
                "flag": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
                "code": 4181,
                "msg": "当前币种未查询到完整的symbol或decimals信息"
            }
        ],
        "successList": [
            {
                "currency": "ERC20",
                "flag": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
                "coinsDoId": "USDT"
            }
        ]
    }
}
```

{% endcode %}

* Data content

<table data-full-width="false" data-search="true"><thead><tr><th width="180.171875">Parameter</th><th width="150.25">Type</th><th>Description</th></tr></thead><tbody><tr><td>total</td><td>integer</td><td>Total number of tokens in this request </td></tr><tr><td>successCount</td><td>integer</td><td>Number of successfully processed tokens (includes idempotent successes, e.g. existing tokens are treated as successful) </td></tr><tr><td>failCount</td><td>integer</td><td>Number of failed tokens</td></tr><tr><td>successList</td><td>array</td><td>Successful token details</td></tr><tr><td>failList</td><td>array</td><td>Failed token details</td></tr></tbody></table>

* successList Element Structure

<table data-full-width="false" data-search="true"><thead><tr><th width="180.171875">Parameter</th><th width="150.1953125">Type</th><th>Description</th></tr></thead><tbody><tr><td>currency</td><td>string</td><td>Token network protocol</td></tr><tr><td>flag</td><td>string</td><td>Token address</td></tr><tr><td>coinsDoId</td><td>string</td><td>CoinsDo token ID returned after a successful creation or idempotent success</td></tr></tbody></table>

* failList Element Structure

<table data-full-width="false" data-search="true"><thead><tr><th width="180.171875">Parameter</th><th width="150.1953125">Type</th><th>Description</th></tr></thead><tbody><tr><td>currency</td><td>string</td><td>Token network protocol</td></tr><tr><td>flag</td><td>string</td><td>Token address</td></tr><tr><td>code</td><td>string</td><td>Error code</td></tr><tr><td>msg</td><td>string</td><td>Error message</td></tr></tbody></table>

**Response status**

<table data-full-width="false"><thead><tr><th width="110.421875">Status code</th><th>Description</th></tr></thead><tbody><tr><td>4002</td><td>The token list cannot be empty.<br>The token list supports a maximum of 10 entries.<br>Token network protocol are required.<br>Identifier is required.<br>Token custom name is required.<br>Timestamp is required.</td></tr><tr><td>4003</td><td>JSON data parsing error</td></tr><tr><td>4004</td><td>APIKEY does not exist</td></tr><tr><td>4005</td><td>IP restricted. Current IP:</td></tr><tr><td>4007</td><td>Signature verification failed</td></tr><tr><td>4010</td><td>Request expired</td></tr><tr><td>4099</td><td>Too many requests</td></tr><tr><td>4181</td><td>Unable to retrieve the complete symbol or decimals information for the token</td></tr></tbody></table>