Binance Smart Chain Documentation

Postman

Postman collection and documentation will follow soon...

---

Tutorials

We wrote a few step-by-step tutorials with example code in PHP that might help you to work with our solution. Currently there is one tutorial for every request type.
Address Requests: Create BSC addresses
Transaction Requests: Send BEP-20 token transactions
Info Requests: Get BEP-20 token balances
IPN/Subscription Requests: Subscribe to BEP-20 token deposits

---

API Requests

All Requests to our API are made in JSON format using HTTP POST. We will also return everything in JSON format. The Europe API endpoint is located at https://eu.bsc.chaingateway.io/v1/{function}.

---

API Key

You can get your personal API Key from your account dashboard. It is used by us to determine who is accessing the API and to count the requests by that account. There are 2 possibilities to use it in your requests:

1. Add it in the HTTP header as
   'Authorization: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m'. This is very secure and may be the only option in future versions.
2. Add it to the JSON body in your request, like
   "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m". This is not recommended!

Please do not share your api key! If you did so by mistake, immediately regenerate it in your account panel!

---

Parameters

Binancecoin Address

This is an Binancecoin address, which has 0x in front and 40 hexadecimal characters after it. CAUTION: If you send tokens, the receiving address must be BEP-20 compatible. So please don't use an exchange address.

Contract Address

The contract address is the binance smart chain contract address of the BEP-20 token you want to use. It has the same format as normal Binancecoin addresses.

Amount

We want amounts to be in normal decimal format and as string. If you want to send 2.5 BNB, use "2.5". If you want to send 1 million tokens, use "1000000". If you are not sure how many decimals a token has, you can use the getToken function. We decided to use amounts in string format to support up to 18 decimals with perfect precision.

Password

Whenever you create a new Binancecoin address, you need to specify a password for it. This password is used for all transactions you are doing with this address. We don't save this password on our end, so please don't lose it.

---

Security

Our API is very secure. The Nodes are not hosted on the same machine as the API endpoint. Also, they are not using the standard port and have a few proxies running in front. They are protected with a few firewalls, ddos protection and breach detection, too. We also have protected our endpoint and nodes against bruteforce. Sensitive data, especially keystores are being saved only with really strong and military proof encryption. But even if someone would get control over our systems, your funds would still be save. Like you can see above, every Binancecoin address needs a password for transactions. Without it, the funds can't be accessed. This means our system is as secure as your application. If you don't secure your system and don't store the passwords in a safe way, attackers may be able to steal funds from your addresses. (They would still need your API Key however)

---

Fees

We are charging on a monthly plan basis if you use our API. You can see the exact pricing and request amounts here. There are also transaction fees, which go to the miners to include your transaction in a block. So please make sure there are always enough Binance coins on the address you are sending tokens or BNB from. The exact fee which is used is determined by the average gas fee at that time (If not specified otherwise).

---

Receiving Subscriptions/IPNs

Once we detect a balance update in one of your subscriptions, we will delay a JSON formatted call to the URL you provided. You will need to return {"ok": true} in JSON format after receiving so our system knows you received the call successfully. If you don't return ok, we will try to send the call again 10 times within 10 minutes.

Here is an explanation of the parameters we send you:


An example of a call would look like this:

{"id": 141854, "action": "deposit", "type": "BEP-20", "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "amount": "0.0464537", "timestamp": "2021-08-30 15:15:39"}

---

getBinancecoinBalance

Endpoint:
https://eu.bsc.chaingateway.io/v1/getBinancecoinBalance

HTTP Method: POST



Example Request JSON:
{"binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok": true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "balance": "0.456"}

---

getTokenBalance

Endpoint:
https://eu.bsc.chaingateway.io/v1/getTokenBalance

HTTP Method: POST



Example Request JSON:
{"contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok": true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "balance": "0.456"}

---

listAddresses

Endpoint:
https://eu.bsc.chaingateway.io/v1/listAddresses

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok":true,"addresses":[{"binancecoinaddress":"0xa1f36016221d48ce7f15cde7b826a4fbe09bacce"}]}

---

importAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/importAddress

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m", "filename": "UTC--2020-05-01T12-30-12.020Z--4fb45889cd2d3348348e39c613c41bf1dc43760a", "content": {"version":3,"id":"f0449f3f-1ef2-5fb9-bf09-20bb72c47167","address":"4fb45889cd2d3348348e39c613c41bf1dc43760a","crypto":{"ciphertext":"027fbbe9d7b91b1a4a3afddcb27a07ac5e7fff550fd167452a6345a961f21a4d","cipherparams":{"iv":"a2b3022a9d7d76ade60dd70e5405cc09"},"cipher":"aes-128-ctr","kdf":"scrypt","kdfparams":{"dklen":32,"salt":"fd84f455da4ad1325cf5bc7beb06bf3052919278c76373a67507aaa68bcebab3","n":131056,"r":6,"p":1},"mac":"d46d36b6facd1f3f5549f01cb5c87de0c01b68b6445410259128c52d515a7b6d"}}, "password": "padN39QkRA2hJ"}

Example Response JSON:
{"ok":true,"binancecoinaddress": "0x4fb45889cd2d3348348e39c613c41bf1dc43760a", "filename": "UTC--2020-05-01T12-30-12.020Z--4fb45889cd2d3348348e39c613c41bf1dc43760a"}

---

exportAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/exportAddress

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m", "binancecoinaddress": "0x4fb45889cd2d3348348e39c613c41bf1dc43760a", "password": "padN39QkRA2hJ"}

Example Response JSON:
{"ok":true, "filename": "UTC--2020-05-01T12-30-12.020Z--4fb45889cd2d3348348e39c613c41bf1dc43760a", "content": {"version":3,"id":"f0449f3f-1ef2-5fb9-bf09-20bb72c47167","address":"4fb45889cd2d3348348e39c613c41bf1dc43760a","crypto":{"ciphertext":"027fbbe9d7b91b1a4a3afddcb27a07ac5e7fff550fd167452a6345a961f21a4d","cipherparams":{"iv":"a2b3022a9d7d76ade60dd70e5405cc09"},"cipher":"aes-128-ctr","kdf":"scrypt","kdfparams":{"dklen":32,"salt":"fd84f455da4ad1325cf5bc7beb06bf3052919278c76373a67507aaa68bcebab3","n":131056,"r":6,"p":1},"mac":"d46d36b6facd1f3f5549f01cb5c87de0c01b68b6445410259128c52d515a7b6d"}}}

---

subscribeAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/subscribeAddress

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m","binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "url": "https://yoururl.com/ipnreceiver.php"}

Example Response JSON:
{"ok":true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "url": "https://yoururl.com/ipnreceiver.php"}

---

UnsubscribeAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/unsubscribeAddress

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m","binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "url": "https://yoururl.com/ipnreceiver.php"}

Example Response JSON:
{"ok":true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "url": "https://yoururl.com/ipnreceiver.php", "deleted": true}

---

listSubscribedAddresses

Endpoint:
https://eu.bsc.chaingateway.io/v1/listSubscribedAddresses

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok":true,"ipns":[{"binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "url": "https://yoururl.com/ipnreceiver.php"}]}

---

listFailedIPNs

Endpoint:
https://eu.bsc.chaingateway.io/v1/listFailedIPNs

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok":true,"failed_ipns":[{"id":"182659","timestamp":"2019-12-18 17:14:36","binancecoinaddress":"0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "contractaddress":null,"amount":"0.0277", "url":"https:\/\/yoururl.com/ipnreceiver.php","action":"withdraw"}]}

---

resendFailedIPN

Endpoint:
https://eu.bsc.chaingateway.io/v1/resendFailedIPN

HTTP Method: POST



Example Request JSON:
{"apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m", "id": 182659}

Example Response JSON:
{"ok":true, "id": 182659}

---

newAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/newAddress

HTTP Method: POST



Example Request JSON:
{"password": "padN39QkRA2hJ", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok": true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "password": "padN39QkRA2hJ"}

---

deleteAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/deleteAddress

HTTP Method: POST



Example Request JSON:
{"binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m", "password": "padN39QkRA2hJ"}

Example Response JSON:
{"ok": true, "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "deleted": true}

---

sendBinancecoin

Endpoint:
https://eu.bsc.chaingateway.io/v1/sendBinancecoin

HTTP Method: POST



Example Request JSON:
{"from": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "to": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "password": "padN39QkRA2hJ", "amount": "0.05", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m", "gas": 21000}

Example Response JSON:
{"ok": true, "txid": "0xcff06775098019d18f7bab6a350c18e86f89399d b63cbce5269104e6c9a79499", "from": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "to": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "amount": "0.05"}

---

clearAddress

Endpoint:
https://eu.bsc.chaingateway.io/v1/clearAddress

HTTP Method: POST



Example Request JSON:
{"binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "newaddress": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "password": "padN39QkRA2hJ", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok": true, "txid": "0xcff06775098019d18f7bab6a350c18e86f89399d b63cbce5269104e6c9a79499", "binancecoinaddress": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "newaddress": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "amount: "0.00980226", "gas": "0.000063", "total": "0.00986526"}

---

sendToken

Endpoint:
https://eu.bsc.chaingateway.io/v1/sendToken

HTTP Method: POST


Example Request JSON:
{"contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "from": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "to": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "password": "padN39QkRA2hJ", "amount": "0.05", "apikey": "q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m"}

Example Response JSON:
{"ok": true, "txid": "0xcff06775098019d18f7bab6a350c18e86f89399d b63cbce5269104e6c9a79499", "contractaddress": "0x5b86a33f0c232fe909eb4602a9d039072869d915", "from": "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce", "to": "0xef4943d727e34280a2efa0b3352dfd61f508ee48", "amount": "0.05"}

---