📙CoinGet

Get receiving address

Retrieve receiving address from address pool.

POST /v1/addressGet

Request

Parameter	Required	Type	Description
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

Parameter	Required	Type	Description
apiKey	Yes	string	API Key
mainnet	Yes	string	Network code, refer to Supported Networks.
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

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

Parameter	Required	Type	Description
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

Status code	Description
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

Parameter	Required	Type	Description
data	Yes	string	Content（JSON string, refer below）

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

• data content

Parameter	Required	Type	Description
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

Parameter	Required	Type	Description
legacyAddr	Yes	string	Legacy format (classic address)
cashAddr	Yes	string	CashAddr format (Standard address)

Response status

Status code	Description
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

Parameter	Required	Type	Description
data	Yes	string	Content（JSON string，refer to below）

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

• Data content

Parameter	Require	Type	Description
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

Status code	Description
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

Parameter	Required	Type	Description
data	Yes	string	Content（JSON string，refer to below）

{
    "apiKey": "d3a0beaa70474d3b",
    "address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
    "coinsDoId": "30",
    "timestamp": 1679397493762
}

• Data content

Parameter	Required	Type	Description
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

Parameter	Required	Type	Description
balance	Yes	string	receiving address’ balance
balanceUpdateTime	Yes	string	Transaction confirmation timestamp(seconds)

Response status

Status code	Description
4034	Failed to verify address
4066	Failed to verify supported tokens
4073	CoinsDoId does not exist
4074	Receiving address does not exist