代幣 API

Token API 提供 FT（可替代代幣）的轉移、查詢和授權。

獲取令牌資訊¶

返回合約地址（contract）的代幣合約資訊。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}
HTTP 方法	GET
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必需
contract	代幣合約的地址	字串	Y

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	是
Authorization	認證令牌，用於調用 API	字串	是

回應¶

字段名稱	描述	類型
code	API 請求結果代碼，0: 成功	數字
message	結果消息	字串
data	API 回應數據	json
data.name	令牌名稱	字串
data.symbol	令牌的符號	字串
data.decimals	令牌的最大小數位數	數字
data.totalSupply	總供應量	字串

請求範例¶

curl -X 'GET' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x94853BdC9c6AdD50D7842D1A3117fab385457470' 
  -H 'accept: application/json' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "name": "Simple Token",
    "symbol": "ST",
    "decimals": 18,
    "totalSupply": "1000000000"
  }
}

獲取代幣餘額¶

返回代幣擁有者帳戶（from）的當前代幣餘額。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}/account/{from}/balance
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}/account/{from}/balance
HTTP 方法	GET
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必需
contract	代幣合約的地址	字串	是
from	代幣擁有者	字串	是

查詢參數¶

欄位名稱	描述	類型	必需
details	是否返回餘額詳細信息	boolean	N

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	是
Authorization	認證令牌，用於調用API	字串	是

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.value	代幣餘額	字串
data.rawValue	未應用 `data.decimals` 的代幣餘額	字串
data.symbol	代幣的符號	字串
data.decimals	代幣的最大小數位數	數字

請求範例¶

curl -X 'GET' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x94853BdC9c6AdD50D7842D1A3117fab385457470/account/0x9428e6eF51FEb2201676deEc11B7E36F7c1F0765/balance?details=true' 
  -H 'accept: application/json' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "value": "999998999",
    "symbol": "ST",
    "decimals": 18,
    "rawValue": "999998999000000000000000000"
  }
}

獲取可用於批准轉移的代幣數量¶

返回令牌擁有者帳戶 from 已批准 spender 帳戶代表擁有者發送的令牌數量。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}/account/{from}/allowance/{spender}
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}/account/{from}/allowance/{spender}
HTTP 方法	GET
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必需
contract	代幣合約的地址	字串	是
from	代幣擁有者	字串	是
spender	被授權發送代幣的帳戶	字串	是

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	Y
Authorization	認證令牌，用於調用 API	字串	Y

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.allowance	可發送的令牌數量	字串

請求範例¶

curl -X 'GET' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x94853BdC9c6AdD50D7842D1A3117fab385457470/account/0x9428e6eF51FEb2201676deEc11B7E36F7c1F0765/allowance/0xFBd488D1b00604d3b05124d80E35FeA9A39C3296' 
  -H 'accept: application/json' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "allowance": "0"
  }
}

發送令牌¶

創建一個將代幣發送到特定地址的交易。from 必須是代幣擁有者。如果接收帳戶（to）是一個合約，則該合約可以使用 data 執行額外的任務。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}/transfer
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}/transfer
HTTP 方法	POST
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必需
contract	代幣合約的地址	字串	Y

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	Y
Authorization	認證令牌，調用 API 時需要	字串	Y

請求主體¶

字段名稱	描述	類型	必需
encoded	返回的交易是否編碼 `true`: 接收編碼的原始交易字符串（`data.rawTx`）。 `false`: 接收解碼的 `data.rawTx`（JSON）。	boolean	N
from	發送代幣的帳戶地址	string	Y
to	接收代幣的帳戶地址	string	Y
amount	要發送的代幣數量	string	Y

回應¶

欄位名稱	描述	類型
code	api 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.rawTx	交易數據	字串或 json
data.hashedTx	這是 hashed `data.rawTx`。當 API 標頭 `x-network` 為 "polygon" 且請求主體 `from` 為多簽錢包地址時，僅返回此值。	字串
data.requestId	可識別每個 API 請求的唯一值	字串

請求範例¶

curl -X 'POST' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x94853BdC9c6AdD50D7842D1A3117fab385457470/transfer' 
  -H 'accept: */*' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...' 
  -H 'Content-Type: application/json' 
  -d '{
  "encoded": true,
  "from": "0x9428e6eF51FEb2201676deEc11B7E36F7c1F0765",
  "to": "0xFBd488D1b00604d3b05124d80E35FeA9A39C3296",
  "amount": "100.55"
}'

回應範例¶

// Polygon
{
  "code": 0,
  "message": "success",
  "data": {
    "rawTx": "02f8738301388181c2846fc23ac0846fc23ad882cdc49494853bdc9c6add50d7842d1a3117fab38545747080b8...",
    "hashedTx": "0x53e8783e4da707daf58c96a8cea278e7b2a8a5f185af0913b518974556c79076...",
    "requestId": "4d4aa1e5-2bfe-4080-b42f-03319810fe29"
  }
}
// XPLA
{
  "code": 0,
  "message": "success",
  "data": {   
   "rawTx": "0x53e8783e4da707daf58c96a8cea278e7b2a8a5f185af0913b518974556c79076.....",
    "reqeustId": "4d4aa1e5-2bfe-4080-b42f-03319810fe29"
  }
}

代表擁有者發送令牌¶

創建一個交易，代表代幣擁有者將代幣發送到特定地址。from 必須是被授權從代幣擁有者（owner）發送代幣的帳戶。如果接收帳戶（to）是一個合約，則此合約可以使用 data 執行額外的任務。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}/transfer-from
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}/transfer-from
HTTP 方法	POST
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必填
contract	合約地址	字串	Y

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	是
Authorization	認證令牌，用於調用 API	字串	是

請求主體¶

欄位名稱	描述	類型	必需
from	被授權發送代幣的帳戶的錢包地址	字串	Y
to	接收代幣的錢包地址	字串	Y
amount	要發送的代幣數量	字串	Y
data	如果接收者是合約，將要發送的數據	字串	Y
owner	代幣擁有者帳戶的錢包地址	字串	Y
encoded	返回的交易是否被編碼 `true`: 接收編碼的原始交易字符串 (`data.rawTx`)。 `false`: 接收解碼的 `data.rawTx` (JSON)。	布林值	N

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.rawTx	交易數據	字串或 json
data.hashedTx	這是雜湊的 `data.rawTx`。當 API 標頭 `x-network` 為 "polygon" 且請求主體 `from` 是多簽錢包地址時，僅返回此值。	字串
data.requestId	可以識別每個 API 請求的唯一值	字串

請求範例¶

curl -X 'POST' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x5bd415aeb2b382c7fac9cc72c1f3994e33ff7b02/transfer-from' 
  -H 'accept: */*' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...' 
  -H 'Content-Type: application/json' 
  -d '{
  "encoded": true,
  "from": "0xA10078576Ca6f63dc6f78ff9a8ed8bd05B51f463",
  "to": "0xdcd51770d06B54204abd8c30A25b4583D4cABa39",
  "amount": "0.000001",
  "owner": "0xD6e69da7f1be111394dfef4C48eaC9b52ddf2Fd0"
}'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "rawTx": "02f8738301388181c2846fc23ac0846fc23ad882cdc49494853bdc9c6add50d7842d1a3117fab38545747080b8...",
    "hashedTx": "0x53e8783e4da707daf58c96a8cea278e7b2a8a5f185af0913b518974556c79076...",
    "requestId": "4d4aa1e5-2bfe-4080-b42f-03319810fe29"
  }
}

授予發送代幣的權利¶

創建一個交易，該交易由from帳戶批准to帳戶代表from帳戶發送amount的代幣。from必須是代幣的擁有者。

請求 URL¶

實時 URL	https://bc-api.qpyou.cn/core/v1/ft/{contract}/approve
沙盒 URL	https://sandbox-bc-api.qpyou.cn/core/v1/ft/{contract}/approve
HTTP 方法	POST
內容類型	application/json

路徑參數¶

欄位名稱	描述	類型	必需
contract	代幣合約的地址	字串	Y

標頭參數¶

欄位名稱	描述	類型	必需
x-network	區塊鏈網絡	字串	Y
Authorization	認證令牌，呼叫 API 所需	字串	Y

請求主體¶

欄位名稱	描述	類型	必要
from	代幣擁有者帳戶的錢包地址	字串	Y
to	接收發送代幣權利的帳戶的錢包地址	字串	Y
amount	要發送的代幣數量	字串	Y
encoded	返回的交易是否編碼 `true`: 接收編碼的原始交易字符串 (`data.rawTx`)。 `false`: 接收解碼的 `data.rawTx`（JSON）。	布林值	N

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0: 成功	數字
message	結果消息	字串
data	API 回應數據	json
data.rawTx	交易數據	字串或 json
data.hashedTx	這是哈希的 `data.rawTx`。當 API 標頭 `x-network` 為 "polygon" 且請求主體 `from` 為多重簽名錢包地址時，僅返回此值。	字串
data.requestId	可識別每個 API 請求的唯一值	字串

請求範例¶

curl -X 'POST' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/0x5bd415aeb2b382c7fac9cc72c1f3994e33ff7b02/approve' 
  -H 'accept: */*' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...' 
  -H 'Content-Type: application/json' 
  -d '{
  "encoded": true,
  "from": "0xD6e69da7f1be111394dfef4C48eaC9b52ddf2Fd0",
  "to": "0xA10078576Ca6f63dc6f78ff9a8ed8bd05B51f463",
  "amount": "100"
}'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "rawTx": "02f8738301388181c2846fc23ac0846fc23ad882cdc49494853bdc9c6add50d7842d1a3117fab38545747080b8...",
    "hashedTx": "0x53e8783e4da707daf58c96a8cea278e7b2a8a5f185af0913b518974556c79076...",
    "requestId": "4d4aa1e5-2bfe-4080-b42f-03319810fe29"
  }
}

部署令牌合約¶

創建一個部署標準代幣合約的交易。

請求 URL¶

實時網址	https://bc-api.qpyou.cn/core/v1/ft/contract
沙盒網址	https://sandbox-bc-api.qpyou.cn/core/v1/ft/contract
HTTP 方法	POST
內容類型	application/json

標頭參數¶

欄位名稱	描述	類型	必填
x-network	區塊鏈網絡	字串	是
Authorization	認證令牌，用於調用API	字串	是

請求主體¶

欄位名稱	描述	類型	必填
from	部署代幣合約的錢包地址	字串	是
name	代幣名稱	字串	是
symbol	代幣的符號	字串	是
decimals	代幣的最大小數位數	數字	是
initialSupply	鑄造的代幣初始數量	字串	是
encoded	返回的交易是否已編碼 `true`: 接收編碼的原始交易字串 (`data.rawTx`)。 `false`: 接收解碼的 `data.rawTx` (JSON)。	布林值	否

回應¶

欄位名稱	描述	類型
code	API 請求結果代碼，0：成功	數字
message	結果消息	字串
data	API 回應數據	json
data.rawTx	交易數據	字串或 json
data.hashedTx	這是雜湊的 `data.rawTx`。當 API 標頭 `x-network` 為 "polygon" 且請求主體 `from` 是多簽錢包地址時，僅返回此值。	字串
data.requestId	可識別每個 API 請求的唯一值	字串

請求範例¶

curl -X 'POST' 
  'https://sandbox-bc-api.qpyou.cn/core/v1/ft/contract' 
  -H 'accept: */*' 
  -H 'x-network: polygon' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJp...' 
  -H 'Content-Type: application/json' 
  -d '{
  "encoded": true,
  "from": "0x9428e6eF51FEb2201676deEc11B7E36F7c1F0765",
  "name": "Simple Token",
  "symbol": "ST",
  "decimals": 18,
  "initialSupply": "1000000000"
}'

回應範例¶

{
  "code": 0,
  "message": "success",
  "data": {
    "rawTx": "02f8738301388181c2846fc23ac0846fc23ad882cdc49494853bdc9c6add50d7842d1a3117fab38545747080b8...",
    "hashedTx": "0x53e8783e4da707daf58c96a8cea278e7b2a8a5f185af0913b518974556c79076...",
    "requestId": "4d4aa1e5-2bfe-4080-b42f-03319810fe29"
  }
}