You can get API key here.
How to install
$ npm install cryptoapis.io
How to use
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
const caClient = new CryptoApis(apiKey);
caClient.BC.DOGE.getSelectedNetwork();
caClient.BC.ETH.switchNetwork(caClient.BC.ETH.NETWORKS.ROPSTEN);
caClient.BC.BTC.switchNetwork(caClient.BC.BTC.NETWORKS.TESTNET);
caClient.BC.BCH.switchNetwork(caClient.BC.BCH.NETWORKS.TESTNET);
caClient.BC.LTC.switchNetwork(caClient.BC.LTC.NETWORKS.TESTNET);
caClient.BC.DOGE.switchNetwork(caClient.BC.DOGE.NETWORKS.TESTNET);
caClient.BC.DASH.switchNetwork(caClient.BC.DASH.NETWORKS.TESTNET);
caClient.BC.ETH.switchNetwork('rinkeby');
Ethereum examples
Generate new address
caClient.BC.ETH.address.generateAddress()
.then(function(result) {
console.log(result);
})
.catch(function(err) {
console.error(err);
});
It will print the following:
{
"payload": {
"address": "0xd1b99ca3971c06af48474aa6606ec885e7aff600",
"privateKey": "31f5d2a8d3f4a816fb498200423461ec52aefe579c13b807a8140c7a7ecc8448",
"publicKey": "51767e84342ea3d10faf35676997cf1dbd4d2c0168fe46a4a920c4c1f557bc8851445ff17aaba144546e7aac45b1754352d860c617eff441778c4e053178f97b"
}
}
Generate new account
const password = 'your password - l3tt3rs and d1g1ts';
caClient.BC.ETH.address.generateAccount(password).then(console.log);
It will print the following:
{
"payload": {
"success": "keystore saved:",
"address": "0x95b954b475b908df6c3ee60db0e23c13607d4971:"
}
}
If an error occurs, it will print the following (e.g. your password is weak):
{
"meta": {
"error": {
"message": "Password is too weak! It should be at least 7 characters and should contain at least one letter and one digit",
"code": 15
}
},
"statusCode": 400
}
Get address balance
const address = '0xd6cb6744b7f2da784c5afd6b023d957188522198';
caClient.BC.ETH.address.getInfo(address).then(console.log);
It will print the following:
{
"payload": {
"chain": "ETH.mainnet",
"address": "0xd6cb6744b7f2da784c5afd6b023d957188522198",
"balance": "1981.86598254851838",
"txs_count": 180546,
"from": 60509,
"to": 120037
}
}
Get block info by number
const blockNumber = 6123321;
caClient.BC.ETH.blockchain.getBlockByHeight(blockNumber).then(console.log);
It will print the following:
{
"payload": {
"chain": "ETH.mainnet",
"height": 6123321,
"hash": "0xdd9cda46ecc76633504931d5f7fd4bbff4c39ca3d6d173550f37789a863135b2",
"parent_hash": "0xa19c2538a3ffa5077645dc1ecef2ef99fcbf9707b106df5536244e87b13d06bc",
"sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
"gas_used": "7992049",
"size": "5332 bytes",
"timestamp": 1533919094,
"date": "2018-08-10 16:38:14 +UTC",
"transactions": 36,
"difficulty": "3544115802240984",
"total_difficulty": "5917863156620322787518",
"gas_limit": "8000029",
"nonce": "0x20f173b005ccec35",
"mined_by": "0xea674fdde714fd979de3edf0f56aa9716b898ec8 (Ethermine) in 3 secs",
"uncles": [],
"extra_data": "0x65746865726d696e652d657538",
"confirmations": 2045393,
"total_fees": "100689146837974998"
}
}
Get an existing transaction by a given hash:
const tx = '0xe7abcffe85acf8e6d3186f1378d201b0857c41d300885c9c3c2f2c72afaecbcd';
caClient.BC.ETH.transaction.getTransaction(tx).then(console.log);
If the queried transaction exists it will print the following:
{
"payload": {
"chain": "ETH.mainnet",
"status": "0x1",
"index": 1,
"hash": "0xe7abcffe85acf8e6d3186f1378d201b0857c41d300885c9c3c2f2c72afaecbcd",
"value": "0",
"from": "0xf51a8cee8d3e9dc1764d2b6ef3fad973ebdb0ec5",
"to": "0x2f141ce366a2462f02cea3d12cf93e4dca49e4fd",
"date": "2018-12-06 10:09:38 +UTC",
"block_hash": "0x503c138005347065a606d3d0d02b3528790227b3a17b6fd6b54ce54ed79f144a",
"block_number": 6836009,
"gas": "36657",
"gas_price": "97000000000",
"gas_used": "36657",
"nonce": 573,
"confirmations": 1332739,
"token_transfers": [
{
"from": "0xf51a8cee8d3e9dc1764d2b6ef3fad973ebdb0ec5",
"to": "0xcfbd73a1404a2cbf956e9e506ff5006601bcd2a4",
"value": "39.000",
"tokenName": "Free Coin",
"symbol": "FREE",
"tokenType": "ERC-20"
}
],
"input": "0xa9059cbb000000000000000000000000cfbd73a1404a2cbf956e9e506ff5006601bcd2a40000000000000000000000000000000000000000000000021d3bd55e803c0000"
}
}
If transaction is not found, the following message will be printed:
{
"meta": {
"error": {
"message": "Transaction not found",
"code": 21
}
},
"statusCode": 404
}
Create payment forwarding using an account
const url = 'https://somepoint.com';
const from = '0x7857af2143cb06ddc1dab5d7844c9402e89717cb';
const to = '0x4ab47e7b0204d6b3bf0e956db14e63142b9b5ab8';
const privateKey = 'your-password-123';
const confirmations = 6;
const gasPrice = 11000000000;
const gasLimit = 21000;
caClient.BC.ETH.paymentForwarding.createPaymentForwarding(url, from, to, privateKey, confirmations, gasPrice, gasLimit).then(console.log);
It will print similar to the following:
{
"payload": {
"uuid": "7f0c4666-af1f-44a3-b5f5-1a3c2b904283",
"from": "0x7857af2143cb06ddc1dab5d7844c9402e89717cb",
"to": "0x4ab47e7b0204d6b3bf0e956db14e63142b9b5ab8",
"confirmations": 2,
"callback": "http://somepoint.com",
"gasPrice": "11000000000",
"gasLimit": "21000"
}
}
If password is misspelled the following will be printed:
{
"meta": {
"error": {
"message": "Wrong password",
"code": 19
}
},
"statusCode": 400
}
Create, sign and send a transaction to the blockchain
const from = '0xc438d912235ff5facc22c502e5bd6dc1ae14a7ff';
const to = '0x0cb1883c01377f45ee5d7448a32b5ac1709afc11';
const gasPrice = 8000000000;
const gasLimit = 30000;
const password = 'your-password-123';
const value = 0.012;
const hexData = 0x123;
caClient.BC.ETH.transaction.newTransaction(from, to, password, value, gasPrice, gasLimit, null, hexData).then(console.log);
It will print similar to the following:
{
"payload": {
"hex": "0xfebf0691cc92f67ace032897a83587c44c5b2ef437341c6cfd5dbf1f8f4c288d"
}
}
Bitcoin, Litecoin, Bitcoin Cash, Doge and DASH examples
Generate new address
caClient.BC.BTC.address.generateAddress().then(console.log);
caClient.BC.LTC.address.generateAddress().then(console.log);
caClient.BC.BCH.address.generateAddress().then(console.log);
caClient.BC.DOGE.address.generateAddress().then(console.log);
caClient.BC.DASH.address.generateAddress().then(console.log);
It will print similar to the following:
{
"payload": {
"privateKey": "2edfe66bed8a17e58cd51a3da72f63d0a6b0ca8775d237772f88e42c27f992e0",
"publicKey": "037039ac5fac75ab9eb8bdbde8a9ba2dc5d7576b711e69a241a5e2dfdbc71647a5",
"address": "1P2CyS7TPqHPQeQExDXSK25hPs2jCk3c46",
"wif": "Kxnq2zxvNatWtHbQzmakRdH21YNozFjD141s2mKpo21C6sVwa16e"
}
}
Get block info by a given hash
const hash = '000000000000000002dbd3af3c654b77ea277238b02df23d93ca6b3e4eedb295';
caClient.BC.BTC.blockchain.getBlockByHash(hash).then(console.log);
caClient.BC.LTC.blockchain.getBlockByHash(hash).then(console.log);
caClient.BC.BCH.blockchain.getBlockByHash(hash).then(console.log);
caClient.BC.DOGE.blockchain.getBlockByHash(hash).then(console.log);
caClient.BC.DASH.blockchain.getBlockByHash(hash).then(console.log);
It will print similar to the following:
{
"payload": {
"hash": "000000000000000002dbd3af3c654b77ea277238b02df23d93ca6b3e4eedb295",
"size": 974324,
"height": 419398,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "67c988f47c40ef54c87d530be54b9a2ee2d575462beda0c920e23f44b2c24ff4",
"time": "2016-07-05 13:07:56 UTC",
"mediantime": "2016-07-05 12:15:24 UTC",
"nonce": 3430795024,
"bits": "180526fd",
"difficulty": 213398925331.3239,
"chainwork": "0000000000000000000000000000000000000000001eb413e634b72bd107f569",
"previousblockhash": "0000000000000000039b2f5bf42183b25299c9ffb4a99111ea35819a701e84a2",
"nextblockhash": "00000000000000000016e54e255f112a015c15f92dfd30f7f5259df6729280c7",
"transactions": 1768,
"tx": [
"48d0c5e7d7f1004e4fda1ad02529b024d59e8d663486d9b9cad4fe92d3f9d63e",
"2046a3a6affe4886c53060f5f5637b9369f188046b2ea2d3172ca99a0bcb7137",
"14f18a93af7ffb3dacec0d419e68efa8a436068390691a5d1f54baedbab55a00"
],
"confirmations": 0,
"timestamp": 1467724076
}
}
Get transactions by index and limit
const blockNumber = 553381;
const index = 23;
const limit = 2;
caClient.BC.BTC.transaction.getTransactionIndexByBlock(blockNumber, index, limit).then(console.log);
caClient.BC.LTC.transaction.getTransactionIndexByBlock(blockNumber, index, limit).then(console.log);
caClient.BC.BCH.transaction.getTransactionIndexByBlock(blockNumber, index, limit).then(console.log);
caClient.BC.DOGE.transaction.getTransactionIndexByBlock(blockNumber, index, limit).then(console.log);
caClient.BC.DASH.transaction.getTransactionIndexByBlock(blockNumber, index, limit).then(console.log);
{
"payload": [{
"txid": "cacb2282399e250bbbe60fbb49e62e60f0bd123563ff853730e038be8e4a116f",
"hash": "cacb2282399e250bbbe60fbb49e62e60f0bd123563ff853730e038be8e4a116f",
"index": 23,
"version": 1,
"size": 3190,
"vsize": 3190,
"locktime": 0,
"time": "2014-04-22 03:48:34 UTC",
"blockhash": "3334d66be09560433bda17f335c4c6d0017be0bc18a887f9596249c2123d3e15",
"blockheight": 553381,
"blocktime": "2014-04-22 03:48:34 UTC",
"timestamp": 1398138514,
"confirmations": 1055211,
"txins": [{
"txout": "ee9f6d825607b6ceb1482139a43394ef9b640383f12b809a046a9dae62f7bd5b",
"vout": 1,
"amount": "0.0139",
"addresses": ["LeqLW7KgkYfaaz2DTSbzh2cZCm8LbUU1NX"],
"script": {
"asm": "304402204d6dde1a7f0db805eccafa7a401f4a6b47d6b144c02a40de8dc77d4743f9691e0220689c55f64912b9cb17387d49ac33326bb8200c81325c0ca257078b1123d40f7a[ALL] 036b503d5b9d37d295aa710179686696a26097c5ded86779d517d99d139e3268e8",
"hex": "47304402204d6dde1a7f0db805eccafa7a401f4a6b47d6b144c02a40de8dc77d4743f9691e0220689c55f64912b9cb17387d49ac33326bb8200c81325c0ca257078b1123d40f7a0121036b503d5b9d37d295aa710179686696a26097c5ded86779d517d99d139e3268e8"
},
"votype": "pubkeyhash"
},
{
"txout": "72229f239e1e07de267310dafca1546d046b2ccb7a8ed97166377e0a029bc7a9",
"vout": 1,
"amount": "1.9639",
"addresses": ["LhUwWyncweni85nat8g6b7YVKfNuJsxi3p"],
"script": {
"asm": "304502201dbaed3e5d9424df9f2c9fded04ff26462dabd94670bdbb343ae81eeaa1c4c8802210087d58c21bca9d8da42f498951afbb43aab1e97247111e13de5caacde994b4317[ALL] 033e300857f2b1751a96fb8dd2262b5a4cd5fd34958a485d5bc33e30fe0a66e6c0",
"hex": "48304502201dbaed3e5d9424df9f2c9fded04ff26462dabd94670bdbb343ae81eeaa1c4c8802210087d58c21bca9d8da42f498951afbb43aab1e97247111e13de5caacde994b43170121033e300857f2b1751a96fb8dd2262b5a4cd5fd34958a485d5bc33e30fe0a66e6c0"
},
"votype": "pubkeyhash"
}],
"txouts": [{
"amount": "40",
"type": "pubkeyhash",
"spent": true,
"addresses": ["LTi2gMpBpV73VeiY3CiSqbkQ5QSeUP2GPC"],
"script": {
"asm": "OP_DUP OP_HASH160 5d1056fa8321e89a47d2718f659c320ea1b9851d OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a9145d1056fa8321e89a47d2718f659c320ea1b9851d88ac",
"reqsigs": 1
}
}, {
"amount": "0.01000521",
"type": "pubkeyhash",
"spent": true,
"addresses": ["LTKqrfL2kjgzBhMJ5JBcSfLY8Mm77FdLEg"],
"script": {
"asm": "OP_DUP OP_HASH160 58de278f79671418afb6dedca037ed28c8e88301 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a91458de278f79671418afb6dedca037ed28c8e8830188ac",
"reqsigs": 1
}
}]
}, {
"txid": "79f9ff7ea230c4bd2a214cf37b577773a2bfe5b6827ca86258a7aa7c538f00ee",
"hash": "79f9ff7ea230c4bd2a214cf37b577773a2bfe5b6827ca86258a7aa7c538f00ee",
"index": 24,
"version": 1,
"size": 967,
"vsize": 967,
"locktime": 0,
"time": "2014-04-22 03:48:34 UTC",
"blockhash": "3334d66be09560433bda17f335c4c6d0017be0bc18a887f9596249c2123d3e15",
"blockheight": 553381,
"blocktime": "2014-04-22 03:48:34 UTC",
"timestamp": 1398138514,
"confirmations": 1055211,
"txins": [{
"txout": "61feafc03b11107e86c3f8e6699a75b87b766d7e222eb9664c1738d05eba74e2",
"vout": 1,
"amount": "0.00015",
"addresses": ["LXwpBzPnMoMAcv4FKnZYXDZE1KkrYC4Dy2"],
"script": {
"asm": "304502206225d41fb743b045e3c8733525a4ae1c6c58a1461f690f722bc2655bdc8fb3e602210081ad463354073dacd8ed0d1da3f418258197508e68508fe54cf27d9299ea348f[ALL] 028b42eb7e6a01fc2cbd1c4a44a212cbd097e2084d70dab167f469e1356cb5116a",
"hex": "48304502206225d41fb743b045e3c8733525a4ae1c6c58a1461f690f722bc2655bdc8fb3e602210081ad463354073dacd8ed0d1da3f418258197508e68508fe54cf27d9299ea348f0121028b42eb7e6a01fc2cbd1c4a44a212cbd097e2084d70dab167f469e1356cb5116a"
},
"votype": "pubkeyhash"
},
{
"txout": "cacb2282399e250bbbe60fbb49e62e60f0bd123563ff853730e038be8e4a116f",
"vout": 1,
"amount": "0.01000521",
"addresses": ["LTKqrfL2kjgzBhMJ5JBcSfLY8Mm77FdLEg"],
"script": {
"asm": "3045022057d48cdd2ba3eaf0c5b6fb04768170e50830f001ec2f476a0cf5e490e2673450022100b9a057699d913a2215b147a27e1c61b6b2d196a6a2aa7b5247f4e75259d51108[ALL] 02f442706d23bf3400d96ba54c9ab54a7ac0a15a4a969b5756ca72588c6c9c9963",
"hex": "483045022057d48cdd2ba3eaf0c5b6fb04768170e50830f001ec2f476a0cf5e490e2673450022100b9a057699d913a2215b147a27e1c61b6b2d196a6a2aa7b5247f4e75259d51108012102f442706d23bf3400d96ba54c9ab54a7ac0a15a4a969b5756ca72588c6c9c9963"
},
"votype": "pubkeyhash"
}],
"txouts": [{
"amount": "0.05",
"type": "pubkeyhash",
"spent": true,
"addresses": ["LbonesQ7pYjfeX8SCnihs4Y53BRYkuxor7"],
"script": {
"asm": "OP_DUP OP_HASH160 b5e8223d2f49348c99f0b8a9971ccedd9a6fb3da OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914b5e8223d2f49348c99f0b8a9971ccedd9a6fb3da88ac",
"reqsigs": 1
}
}, {
"amount": "0.00014521",
"type": "pubkeyhash",
"spent": true,
"addresses": ["LQgaa4x3Dh8bs1ZdB1LgrWWTAiwWK7QD4U"],
"script": {
"asm": "OP_DUP OP_HASH160 3be1c0903a68529c07f048b474c000208e82b619 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a9143be1c0903a68529c07f048b474c000208e82b61988ac",
"reqsigs": 1
}
}]
}],
"meta": {
"totalCount": 25,
"index": 23,
"limit": 2,
"results": 2
}
}
Create, sign and send a transaction to the blockchain
const inputs = [
{
address: 'mtFYoSowT3i649wnBDYjCjewenh8AuofQb',
value: 0.0003
},
{
address: 'mn6GtNFRPwXtW7xJqH8Afck7FbVoRi6NF1',
value: 0.001
}
];
const outputs = [
{
address: 'mrnWMV41vXivQX9yiY9ACSK5uPo3TfJdv9',
value: 0.0013
}
];
const fee = {
value: 0.00145,
address: 'mmskWH7hG9CJNzb16JaVFJyWdgAwcVEAkz'
};
const wifs = [
'cUGddnJmuzfzpWXNwt1SRnQ8GMqZdQ1vg8BtwjG8f275pvExPzaX',
'cSEjySAREyai8eQhgoqixzmxCeSP8QtbwHxptL8ijofg68ZMjoud',
'cPo4XXgsnkVdg93GqR8M1iCDGk6Tgywk5gng4rSpoMVzpQx13WmA',
];
caClient.BC.BTC.transaction.newTransaction(inputs, outputs, fee, wifs).then(console.log);
It will print similar to the following:
{
"payload": {
"txid": "fa4ea6eb1947ae94040fd416afd8262016e6f8c0e69bae94c1dd9a4a80a92b7e"
}
}
Create wallet
const walletName = 'demoWallet';
const addresses = [
'LLrxRzrNVxyVQ2DjuMoCNEMN2YM2nkwr1K',
'LiLGYuVLV4HExGYizwZEjTpTG2apN4or8M',
'LP3LrpZDjCDhysQarq4STG97sH8a8Yf748'
];
caClient.BC.LTC.wallet.createWallet(walletName, addresses).then(console.log);
It will print similar to the following:
{
"payload": {
"walletName": "demoWallet",
"addresses": ["LLrxRzrNVxyVQ2DjuMoCNEMN2YM2nkwr1K", "LiLGYuVLV4HExGYizwZEjTpTG2apN4or8M", "LP3LrpZDjCDhysQarq4STG97sH8a8Yf748"],
"hd": false
}
}
Create HD wallet
const walletName = 'demoHDWallet';
const addressCount = 5;
const password = 'your password - l3tt3rs and d1g1ts';
caClient.BC.BCH.wallet.createHDWallet(walletName, addressCount, password).then(console.log);
It will print similar to the following:
{
"payload": {
"walletName": "demoHDWallet",
"addresses": [{
"address": "bitcoincash:qz5c8fpj25hz8wmnqy2k04enwvd937k89ur7hcft6e",
"legacy": "1GTJu2NexADzFcFhvqozHczVP7h1uh1WzN",
"path": "M/0H/0/0"
}, {
"address": "bitcoincash:qr6rvvvh4u8v9vaq4kuf7rh00r8smu78cy3sycwmdq",
"legacy": "1PGGoFdvDQQmEZuTuwNQFo7vwfWhpAi2Ji",
"path": "M/0H/0/1"
}, {
"address": "bitcoincash:qzr6tqax9hhr77x9a2ttffc6ktgal2rtwyprcsha9s",
"legacy": "1DNEW2gwyL2XnTLgCcsYt1kM9KMpFz3ni7",
"path": "M/0H/0/2"
}, {
"address": "bitcoincash:qzhcldlhnk6s9gjmgx6nkypxrwfjslu7r5yph59svl",
"legacy": "1H1HRKHVS6pMHCcbYDTVegwyFgj77Lz27U",
"path": "M/0H/0/3"
}, {
"address": "bitcoincash:qpkv6ufumrka40ca8c8px8kftnj48tch7u9afwd65e",
"legacy": "1AvJ66sw83hC9v1KZBG7rTYNxpxKwrsdTN",
"path": "M/0H/0/4"
}],
"hd": true
}
}
Add address to wallet
const walletName = 'demoWallet';
caClient.BC.LTC.wallet.generateAddressInWallet(walletName).then(console.log);
It will print similar to the following:
{
"payload": {
"wallet_info": {
"walletName": "demoWallet",
"addresses": ["LLrxRzrNVxyVQ2DjuMoCNEMN2YM2nkwr1K", "LiLGYuVLV4HExGYizwZEjTpTG2apN4or8M", "LP3LrpZDjCDhysQarq4STG97sH8a8Yf748", "LfX7oHnE37ch1KYmn8RFbtfNbFWnngmYW7"],
"hd": false
},
"address_info": {
"privateKey": "4442839f4f27fff266ce22bcfb1edd8135792a52d086649874007bcc8eb23f71",
"publicKey": "02737644477a499f487d07359a35e6dda11afc0f656ec5cbe693ae02060b91ef06",
"address": "LfX7oHnE37ch1KYmn8RFbtfNbFWnngmYW7",
"wif": "T5LfYR3EKoidySNmsaALbpWPQDJZyAFAsZXP4B9Gd19kMsukJC1v"
}
}
}
Create Transaction Using HDWallet
const walletName = 'demohdwallet';
const password = 'password';
const outputs = [
{
address: 'my4TmbbhJCLJB9q1eHUHQWJfbbJoYdLwtE',
value: 0.003
}
];
const fee = {
value: 0.00023141
};
caClient.BC.BCH.transaction.createHDWalletTransaction(walletName, password, outputs, fee).then(console.log);
It will print similar to the following:
{
"payload": {
"txid":"1a6bffc375ecd14eb8fa85308baae86a68278cb12d78a2aedbb014c10fb080a1"
}
}
Create Confirmed Transaction Webhook
const url = 'https://somepoint.com';
const tx = '909d545c8ca26a754118f88939ff38a76dad2a06fdff6117c4b6b029f6330625';
const confirmations = 6;
caClient.BC.BTC.webhook.createConfirmedTransactionWebHook(url, tx, confirmations).then(console.log);
It will print similar to the following:
{
"payload": {
"uuid": "de6c3898-b6a0-44be-8ff8-f2beb83dd09f",
"event": "CONFIRMED_TX",
"transaction": "909d545c8ca26a754118f88939ff38a76dad2a06fdff6117c4b6b029f6330625",
"confirmations": 6,
"url": "https://somepoint.com"
}
}
Get blockchain info
caClient.BC.DOGE.blockchain.getInfo().then(console.log);
It will print similar to the following:
{
"payload": {
"difficulty": 6329995.2247605,
"headers": 2745874,
"chain": "main",
"chainWork": "0000000000000000000000000000000000000000000001eedd07ae5c113b9d92",
"blocks": 2745874,
"bestBlockHash": "c895d63eb2f7e306bc6d1df85e085d13ed83509dc70ba9ce3f84564461bbd234",
"currency": "DOGE",
"transactions": 12687555,
"verificationProgress": 0.99999946
}
}
Exchanges examples
Get specific rate - ExchangeRates
const baseAsset = 'USD';
const quoteAsset = 'BTC';
caClient.CMD.exchangeRates.getSpecificRate(baseAsset, quoteAsset).then(console.log);
It will print similar to the following:
{
"payload": {
"weightedAveragePrice": 0.0001908939768173263,
"medianPrice": 0.0001914660979263376,
"weightedMedianAveragePrice": 0,
"timestamp": 1555484749,
"baseAsset": "USD",
"quoteAsset": "BTC"
}
}
List all exchanges - Metadata
const limit = 5;
caClient.CMD.meta.listAllExchanges(0, limit);
It will print similar to the following:
{
"meta": {
"totalCount": 25,
"index": 0,
"limit": 5,
"results": 5
},
"payload": [{
"exchangeId": "BINANCE",
"name": "Binance",
"website": "https:\/\/www.binance.com\/",
"_id": "5b1ea9d21090c200146f7362"
}, {
"exchangeId": "COINBASE",
"name": "GDAX",
"website": "https:\/\/www.gdax.com\/",
"_id": "5b1ea9d21090c200146f7363"
}, {
"exchangeId": "BITSTAMP",
"name": "Bitstamp Ltd.",
"website": "https:\/\/www.bitstamp.net\/",
"_id": "5b1ea9d21090c200146f7364"
}, {
"exchangeId": "BITTREX",
"name": "Bittrex",
"website": "https:\/\/bittrex.com\/",
"_id": "5b1ea9d21090c200146f7366"
}, {
"exchangeId": "POLONIEX",
"name": "POLONIEX",
"website": "https:\/\/poloniex.com\/",
"_id": "5b1ea9d21090c200146f7367"
}]
}
Get latest data - OHLCV
const symbolId = '5bfc325e9c40a100014db989';
const period = '1day';
const limit = 2;
caClient.CMD.OHLCV.latestData(symbolId, period, limit).then(console.log);
It will print similar to the following:
{
"meta": {
"totalCount": 23
},
"payload": [{
"exchange": "5b1ea9d21090c200146f7366",
"eventType": "SPOT",
"assetBase": "5b1ea92e584bf5002013066a",
"assetQuote": "5b755dacd5dd99000b3d92b2",
"timePeriodStart": 1545091200,
"timePeriodEnd": 1545177600,
"timeOpen": 1545095064,
"timeClose": 1545105503,
"priceOpen": 0.00536766,
"priceClose": 0.00533631,
"priceLow": 0.00533631,
"priceHigh": 0.00540231,
"volumeTraded": 1713.40194932,
"tradesCount": 10,
"_id": "5c1a11c0481c5700015eaeff",
"_created": 1545212352,
"_lastModified": 1545218854
}, {
"exchange": "5b1ea9d21090c200146f7366",
"eventType": "SPOT",
"assetBase": "5b1ea92e584bf5002013066a",
"assetQuote": "5b755dacd5dd99000b3d92b2",
"timePeriodStart": 1545004800,
"timePeriodEnd": 1545091200,
"timeOpen": 1545025630,
"timeClose": 1545073697,
"priceOpen": 0.00547147,
"priceClose": 0.00539047,
"priceLow": 0.00535,
"priceHigh": 0.00548921,
"volumeTraded": 64723.87729499,
"tradesCount": 260,
"_id": "5c195cc2481c57000121f344",
"_created": 1545166018,
"_lastModified": 1545198267
}]
}
Get latest data by - Trades
const symbolId = '5bfc32a29c40a100014dc5f6';
caClient.CMD.trades.getLatestDataBySymbol(symbolId).then(console.log);
It will print similar to the following:
{
"meta": {
"totalCount": 170,
"index": 0,
"limit": 1,
"results": 1
},
"payload": [{
"exchangeId": "5b4e131b6ab304000a106945",
"exchangeSequenceId": "dc5d8abc-cb3b-43a2-9350-c983ef368c09",
"eventTime": 1555488112732,
"baseAsset": "5b1ea92e584bf50020130845",
"quoteAsset": "5b755dacd5dd99000b3d92b2",
"price": 2.679e-5,
"amount": 14142.4,
"direction": "SELL",
"tradeType": "SPOT"
}]
}
Trading - Services/Methods
| Exchange Accounts |
Private APIs |
| create |
listAllExchanges |
| listAll |
getBalance |
| get |
getDepositAddress |
| update |
getMyTrades |
| delete |
getOpenOrders |
|
createOrder |
|
cancelOrder |
|
withdraw |
Exchanges - Services/Methods
| Base |
ExchangeRatesService |
MetadataService |
OHLCVService |
TradesService |
OrderBookService |
| listAllExchanges |
getSpecificRate |
listAllExchanges |
listAllPeriods |
getLatestData |
getSnapshotBySymbol |
| getExchangeDetails |
getAllCurrentRates |
listAllAssets |
latestData |
getLatestDataBySymbol |
|
| listAllAssets |
|
listAllSymbols |
historicalData |
getLatestDataByExchange |
|
| getAssetDetails |
|
|
|
getLatestDataByAsset |
|
| getSymbolDetails |
|
|
|
getLatestDataByAssetsPair |
|
|
|
|
|
getLatestDataByExchangeAssetsPair |
|
|
|
|
|
tradesGetHistoricalData |
|
|
|
|
|
tradesGetHistoricalDataByExchange |
|
|
|
|
|
tradesGetHistoricalDataByAsset |
|
|
|
|
|
tradesGetHistoricalDataByAssetPair |
|
|
|
|
|
tradesGetHistoricalDataByExchangeAssetPair |
|
Ethereum (ETH), Ethereum Classic (ETC) - Services/Methods
| AddressService |
BlockchainService |
ContractService |
PaymentForwardingService |
TokenService |
TransactionService |
WebhookService |
| getInfo |
getInfo |
estimateSmartContractGas |
createPaymentForwarding |
getAddressTokenBalance |
getTransaction |
createNewBlockWebHook |
| getTransactionsByAddress |
getBlockByHash |
deploySmartContract |
listPayments |
transferTokens |
getTransactionsByBlock |
createConfirmedTransactionWebHook |
| generateAddress |
getBlockByHeight |
|
listPaymentsHistory |
getTokenTransactionsByAddress |
getTransactionByBlockNumber |
createAddressTransactionWebHook |
| generateAccount |
getLatestBlock |
|
deletePayment |
getAddressTokenTransfers |
getTransactionByBlockHash |
createTransactionConfirmationsWebHook |
| getAddressTransactions |
|
|
|
getTotalSupplyAndDecimals |
newTransaction |
createTokenWebHook (not supported in ETC) |
| getAddressNonce |
|
|
|
getAllTokens (Ethereum) |
newAllTransaction |
listAllHooks |
| multipleAddressesInfo |
|
|
|
|
newTransactionWithPrivateKey |
deleteWebHook |
|
|
|
|
|
newAllTransactionWithPrivateKey |
|
|
|
|
|
|
sendTransaction |
|
|
|
|
|
|
pushTransaction |
|
|
|
|
|
|
estimateTransactionGas |
|
|
|
|
|
|
getPendingTransactions |
|
|
|
|
|
|
getQueuedTransactions |
|
|
|
|
|
|
getTransactionsFee |
|
|
|
|
|
|
refund |
|
Bitcoin (BTC), Litecoin (LTC), Bitcoin Cash (BCH), Dogecoin (DOGE), DASH - Services/Methods
| AddressService |
BlockchainService |
PaymentForwardingService |
TransactionService |
WalletService |
WebhookService |
| getInfo |
getInfo |
createPaymentForwarding |
getTransaction |
createWallet |
createNewBlockWebHook |
| getInfoMultisig (not supported in Dogecoin/DASH) |
getBlockByHash |
deletePayment |
getTransactionIndexByBlock |
createHDWallet |
createConfirmedTransactionWebHook |
| generateAddress |
getBlockByHeight |
listPayments |
getUnconfirmedTransactions |
listWallets |
createAddressTransactionWebHook |
| getAddressTransactions |
getLatestBlock |
listPaymentsHistory |
decodeRawTransaction |
listHDWallets |
createTransactionConfirmationsWebHook |
| multipleAddressesInfo |
|
|
createTransaction |
getWallet |
createOmniConfirmedTransactionWebHook (BTC) |
|
|
|
signTransaction |
getHDWallet |
createOmniTransactionConfirmationsWebHook (BTC) |
|
|
|
sendTransaction |
addAddressToWallet |
createOmniTokenWebHook (BTC) |
|
|
|
newTransaction |
generateAddressInWallet |
listAllHooks |
|
|
|
createHDWalletTransaction |
generateAddressInHDWallet |
deleteWebHook |
|
|
|
getTransactionsFee |
removeAddressFromWallet |
deleteAllMyWebhooks |
|
|
|
refund |
deleteWallet |
|
|
|
|
|
deleteHDWallet |
|
|
|
|
|
createXPub |
|
|
|
|
|
getXPubChangeAddresses |
|
|
|
|
|
getXPubReceiveAddresses |
|
