📙CoinGet
Get receiving address
Retrieve receiving address from address pool.
POST /v1/addressGet
Request
data
Yes
String
Content（JSON string，refer below）
{
"apiKey": "cd384rt80f5575dc",
"mainnet": "TRX",
"targetDeviceUuid": "085C28EC-0BD6-442B-8232-D23BC8F4D58E",
"timestamp": "1622775712229",
"addressRemark": "trx address"
}Data parameter
apiKey
Yes
String
API Key
targetDeviceUuid
Yes
String
CoinGet device UUID
timestamp
Yes
String
Timestamp (seconds or milliseconds)
addressRemark
No
String
Address remarks
isConvert
No
String
Do you want to convert the address? 0. No - default 1. Yes, only used by BCH currently to convert to legacy address)
Request example 1
{
"data": "{\"apiKey\":\"cd384rt80f5575dc\",\"mainnet\":\"TRX\",\"targetDeviceUuid\":\"085C28EC-0BD6-442B-8232-D23BC8F4D58E\",\"timestamp\":\"1622775712229\",\"addressRemark\":\"trx address\"}",
"sign": "67355f9ad0db846edd05761462edfc1f8d396af2624e8998ee52c010c7a60dbd"
}Request example 2
{
"data":"{\"mainnet\":\"BCH\",\"targetDeviceUuid\":\"92E30E38-63A1-41DC-B95C-8E729DFDDE7A\",\"apiKey\":\"4c90b98cc97b45b2\",\"isConvert\":\"1\",\"timestamp\":2639477935817}",
"sign":"7d9ae0b10068422ff30be92f45bdda0fe69bf405224564cefdc81775241d4081"
}Response example 1
{
"code": 200, // Status code
"msg": "Success", // Remarks
"data": {
"address": "TKU69qcQPoR5jDEE7ertPpdaxoLGCTX4xR",
"addrSign": "TESTTESTU4u0dj5xXEoZ9E4EXSes9WawqfpxrRfOIHgXV1BnPNM2tt0DLloCnJkzR7smC26+z6kuZb87s3hitZWgM3UaWWghB8/qNMQImvCZ6MREqChoNmEVyaqCnTbjorKsrU/V0=",
"convertedAddr": null
}
}Response example 2
{
"code": 200,
"msg": "Success",
"data": {
"address": "bchtest:qzfr5996z72me99flf32jf6yfs38hshcwcp3dx8eja",
"addrSign": "ZJA+/GJGNUXFw2soBGBaEbWFSOPtNMD8eRdVLTyZyuKHjnyklWvGe8SqkV8xxhwlFcT1+td9AbKstLD6b+lJ4jSCIqm5WbcMJjo0k1mCdihAagsbn5zVyTYEO7LQac341wP/76jopdYnH/yVvP5VtcNq8ZgkrcOi08ReLaQsMO8=",
"convertedAddr": "mtr8XbbzhJVG2TYy3bYFxfV5TBw8PSEzkB"
}
}
Data content
address
Yes
String
Receiving address
addrSign
Yes
String
Receiving address signature (Verify address through CoinGet’s public key)
convertedAddr
No
String
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)
Response Status
4042
Failed to verify collection wallet
4043
Collection wallet does not exist
4044
Failed to receive collection address
4045
Insufficient addresses
4050
Currently does not support this mainnet
4051
EOS chain does not require a collection address
4052
Token does not require a collection address
4053
Failed to convert BCH address
4061
Failed to verify linked records
4062
Unable to generate address from a linked mainnet
4063
Failed to verify gas fee address
4064
Mainnet not supported by your dispatch wallet. Please update your dispatch wallet
4071
Select a mainnet
4072
Failed to verify mainnet
Convert BCH address
Convert BCH Legacy address to Cash address
Request
POST /v1/bchAddrConvert
data
Yes
String
Content（JSON string, refer below）
{
"apiKey": "4c90b98cc97b45b2",
"address": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
"timestamp": "2639474345487"
}data content
apiKey
Yes
String
API Key
address
Yes
String
BCH address，Legacy (classic) and CashAddr (Standard)
timestamp
Yes
String
Timestamp(seconds or milliseconds)
Request example 1
{
"data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s\",\"timestamp\":\"2639474345487\"}",
"sign":"fc2ed2d7713a499ff718e69507cb95b1a49ac00f4be1daf34187381b8afc43c9"
}Request example 2
{
"data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca\",\"timestamp\":\"2639474345487\"}",
"sign":"7acecc69f1b8c05be5ebfc8435d9fea0cf39aa9138af22084f3a9aa96b323844"
}Response
Response example 1
{
"code": 200,
"msg": "success",
"data": {
"legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
"cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
}
}Response example 2
{
"code": 200,
"msg": "success",
"data": {
"legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
"cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
}
}data parameters
legacyAddr
Yes
String
Legacy format (classic address)
cashAddr
Yes
String
CashAddr format (Standard address)
Response status
4053
Failed to convert BCH address
4054
Wrong format for BCH address
4055
Failed to verify BCH address
Token sweep
Trigger token sweep on specific address
Request
POST /v1/manualCollect
data
Yes
String
Content（JSON string，refer to below）
{
"apiKey": "4c90b98cc97b45b2",
"address": "0xd065380c78847bfba75ad158067a5e8e845205f0",
"coinsDoId": "22",
"collectAmount": "0.12",
"timestamp": "1671699594204"
}Data content
apiKey
Yes
String
API KEY
address
Yes
String
Receiving address
coinsDoId
Yes
String
CoinsDo assigned Token ID(Refer to token list)
collectAmount
No
String
Collection amount(will collect all available balance if not filled)
timestamp
Yes
String
Timestamp (in seconds or milliseconds)
Request example 1
{
"data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"timestamp\":\"1671698862478\"}",
"sign":"bca9130ebc1998e2fea8c81bf480f13dbdd7259f05ac7019f47a70bc8bae407f"
}Request example 2
{
"data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"collectAmount\":\"0.12\",\"timestamp\":\"1671699594204\"}",
"sign":"278682f15ae9afba34566b79eb26d90b1ba5d5542f53a2a6b650542265aac429"
}Response
Response example
{
"code": 200, // status code
"msg": "成功", // message
"data": null // response data
}Response status code
4066
Failed to verify supported tokens
4073
CoinsDoId does not exist
4074
Receiving address does not exist
4075
Wallet version not supported
4076
Insufficient balance
4077
Existing collections not yet complete
4078
Wallet collection switch not turned on
4079
Failed to save manual collection record
4080
Failed to query minimum balance configuration
4081
Failed to query manual collection record
4082
Collection amount should be greater than 0
Get address balance
Retrieve address balance info
Request
POST /v1/balanceGet
data
Yes
String
Content（JSON string，refer to below）
{
"apiKey": "d3a0beaa70474d3b",
"address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
"coinsDoId": "30",
"timestamp": 1679397493762
}Data content
apiKey
Yes
String
API KEY
address
Yes
String
Receiving address
coinsDoId
Yes
String
CoinsDo assigned Token ID(Refer to token list)
timestamp
Yes
String
Timestamp (in seconds or milliseconds)
Request example
{
"data":"{\"address\":\"r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR\",\"apiKey\":\"d3a0beaa70474d3b\",\"coinsDoId\":\"30\",\"timestamp\":\"1679497593762\"}",
"sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}Response
Response example
{
"code": 200,
"msg": "成功",
"data": {
"balance": 15.000000000000000000,
"balanceUpdateTime": "1669712411"
}
}Data parameter
balance
Yes
String
receiving address’ balance
balanceUpdateTime
Yes
String
Transaction confirmation timestamp(seconds)
Response status
4034
Failed to verify address
4066
Failed to verify supported tokens
4073
CoinsDoId does not exist
4074
Receiving address does not exist
Get collection statistics
Retrieve gas fee address statistics
Request
POST /v1/collectStatistic
data
Yes
String
Content (JSON string, as shown below)
{
"apiKey": "7bb52d79e46e47ab",
"depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
"startTime": "1738886400",
"endTime": "1738943999",
"timestamp": "1740379248"
}data content
apiKey
Yes
String
API Key
depositDeviceUuid
Yes
String
CoinGet device UUID
startTime
Yes
String
Start time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)
endTime
Yes
String
End time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)
timestamp
Yes
String
Timestamp (seconds or milliseconds)
Request example
{
"data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
"sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}Response
Response example
{
"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
deviceName
Yes
String
CoinGet client name
deviceRemark
Yes
String
CoinGet client remark
depositDeviceUuid
Yes
String
CoinGet client UUID
details
Yes
Array
Collection statistics
detail parameters
chain
Yes
String
Mainnet
currency
Yes
String
Coin name/protocol
currencyName
Yes
String
Coin name
flag
Yes
String
Token address
customName
No
String
Coin custom name
collectedAmount
Yes
Decimal
Collected amount
uncollectedAmount
Yes
Decimal
Uncollected amount
lastUpdateTime
No
String
Last update time
currencyType
Yes
Integer
Coin type: 0. Native coin 1. Non-native coin
Response status
4002
Invalid parameter format
4003
JSON parsing error
4004
APIKEY does not exist
4005
IP restricted, current IP:
4007
Signature verification failed
4010
Request expired
4032
Wallet query failed
4068
Failed to validate API Key
4099
Too many requests
4116
The selected time range is outside the allowed limit
4118
Failed to retrieve currency control settings
4119
Failed to query supported coin list
4120
Failed to query collection statistics
4123
Start time cannot be after the end time
4124
Time range cannot cross calendar days
Get collection gas fee statistics
Retrieve collection gas fee statistics
Request
POST /v1/collectStatisticFee
data
Yes
String
Content (JSON string, as shown below)
{
"apiKey": "7bb52d79e46e47ab",
"depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
"startTime": "1738886400",
"endTime": "1738943999",
"timestamp": "1740379248"
}data content
apiKey
Yes
String
API Key
depositDeviceUuid
Yes
String
CoinGet device UUID
startTime
Yes
String
Start time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)
endTime
Yes
String
End time (UTC+0 Time Zone) (Maximum search range of one day and cannot cross calendar days)
timestamp
Yes
String
Timestamp (seconds or milliseconds)
Request example
{
"data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
"sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}Response
Response example
{
"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
deviceName
Yes
String
CoinGet client name
deviceRemark
Yes
String
CoinGet client remark
depositDeviceUuid
Yes
String
CoinGet client UUID
details
Yes
Array
Gas fee address statistics
detail parameters
chain
Yes
String
Mainnet
currency
Yes
String
Coin name/protocol
currencyName
Yes
String
Coin name
flag
Yes
String
Token address
customName
No
String
Coin custom name
usedFeeAmount
Yes
Decimal
Used gas fee amount
unusedFeeAmount
Yes
Decimal
Unused gas fee amount
lastUpdateTime
No
String
Last update time
currencyType
Yes
Integer
Coin type: 0. Native coin 1. Non-native coin
Response status
4002
Invalid parameter format
4003
JSON parsing error
4004
APIKEY does not exist
4005
IP restricted, current IP:
4007
Signature verification failed
4010
Request expired
4032
Wallet query failed
4068
Failed to validate API Key
4099
Too many requests
4116
The selected time range is outside the allowed limit
4118
Failed to retrieve currency control settings
4119
Failed to query supported coin list
4121
Failed to query collected gas fee address statistics
4123
Start time cannot be after the end time
4124
Time range cannot cross calendar days
Get Receiving Record
Retrieve receiving record info
Request
POST /v1/depositRecordPageGet
data
Yes
String
Content (JSON string, as shown below)
{
"apiKey": "aa465953d55641b3",
"timestamp": 2622775712229,
"pageNum": 1,
"pageSize": 100,
"startArrivalTime": 1763913600000,
"endArrivalTime": 1763999999000
}Data parameter
apiKey
Yes
String
API Key
timestamp
Yes
Integer
Timestamp (in seconds or milliseconds)
pageNum
No
Integer
Current page number (cannot be less than 1)
pageSize
No
Integer
Records per page (must be between 15 and 100)
startArrivalTime
Yes
Integer
Received start date and time (in milliseconds)
endArrivalTime
Yes
Integer
Received end date and time (in milliseconds)
Request example
{
"data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"timestamp\":2622775712229,\"pageNum\":1,\"pageSize\":15,\"startArrivalTime\":1763913600000,\"endArrivalTime\":1763999999000}",
"sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}Response
Response example
{
"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
merchantId
Yes
Long
Corporate ID
amount
Yes
String
Received amount
callBackStatus
Yes
Integer
Received notice: -1 - Callback not required 0 - Pending callback 1 - Callback successful 2 - Callback failed
createTime
Yes
String
Received time
currency
Yes
String
Coin name/protocol
depositDeviceUuid
Yes
String
CoinGet client UUID
depositSign
Yes
String
Receiver signature
depositType
Yes
Integer
Deposit type: 0 - Transfer 1 - Gas Fee Transfer 2 - Change
flag
Yes
String
Token address
fromAddress
Yes
String
Sender address
ignoreCheck
Yes
Integer
Ignore check: 0 - Not ignored 1 - Ignore
toAddress
Yes
String
Receiver address
txHash
Yes
String
Transaction hash
txIndex
Yes
Integer
Transaction sequence number
txMemo
Yes
String
On-chain remark
txTime
Yes
String
Transaction time
txFee
Yes
String
Gas fee
Response status
4002
APIKEY cannot not be empty sign cannot not be empty Current page number cannot be less than 1 Records per page must be between 15 and 100 Timestamp cannot not be empty Received start date and time cannot not be empty Received end date and time cannot not be empty
4004
APIKEY does not exist
4007
Signature verification failed
4099
Too many requests
4010
Request expired
4163
The time range between the received start and end date and time cannot exceed 24 hours.
Last updated
Was this helpful?