cryptoapis.io
Advanced tools
CryptoAPIs SDK for all Exchanges endpoints. You can get API key here.
$ npm install cryptoapis.io
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getAllExchanges().then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Check out CryptoAPIs documentation for more information.
apiKey String Your API keyGet a detailed list of all supported exchanges provided by CryptoAPIs.
skip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var skip = 0;
var limit = 20;
var caClient = new CryptoApis(apiKey);
caClient.getAllExchanges(skip, limit).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get detailed list of all associated assets.
skip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var skip = 0;
var limit = 5;
var caClient = new CryptoApis(apiKey);
caClient.getAllAssets(skip, limit).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get a detailed list of all symbol mappings.
skip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var skip = 0;
var limit = 10;
var caClient = new CryptoApis(apiKey);
caClient.getAllSymbols(skip, limit).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get exchange rates between pair of requested assets.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getSpecificRate('BTC', 'USD').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get the current exchange rate between requested asset and all other assets.
baseAsset String Base asset identifierconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getAllCurrentRates('BTC').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get full list of time periods available for requesting OHLCV data.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getOHLCVPeriods().then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get OHLCV latest time-series data for requested symbol and period, returned in time descending order.
symbol String Symbol identifier used to filter response.period String Periodlimit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getOHLCVLatestData('5bfc329f9c40a100014dc5a7', '1day', 10).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get OHLCV time-series data for requested symbol and period, returned in time ascending order.
symbol String Symbol identifier used to filter response.period String PeriodtimePeriodStart (Number | String) Time period starttimePeriodEnd (Number | String) Time period endlimit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getOHLCVHistoricalData('5bfc329f9c40a100014dc5a7', '1day', 1542955177, 1556355177, 2).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get latest trades from all symbols up to 1 hour ago
skip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.tradesGetLatestData(0, 10).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get latest trades from a specific symbol without time limitation
symbol String Symbol identifier used to filter response.const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.tradesGetLatestDataBySymbol('5bfc329f9c40a100014dc5a7').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get history transactions from specific symbol, returned in time ascending order. If no start & end time is defined, your data results will be provided 24 hours back, by default.
symbol_id String Symbol identifier used to filter response.timeStart (Number | String) Time starttimeEnd (Number | String) Time endskip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.tradesGetHistoricalData('5bfc329f9c40a100014dc5a7', 1542955177, 1556355177, 0, 10).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get latest quote updates for up to 1 hour ago.
skip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.quotesGetLatestData().then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get historical quote updates within requested time range, returned in time ascending order.
symbol_id String Symbol identifier used to filter response.timeStart (Number | String) Time starttimeEnd (Number | String) Time endskip (optional) Number Offset results. Default value is 0limit (optional) Number Limit results. Default limit is 100const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.quotesGetHistoricalData('5bfc329f9c40a100014dc5a7', 1532955177, 1556355177, 0, 50).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
General information about a blockchain.
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinInfo('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Block endpoint gives you detail information for particular block in the blockchain.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinBlock('mainnet', 546903).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Latest Block Endpoint gives you detail information for the latest block in the blockchain.
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinLatestBlock('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
The default Address Endpoint strikes a general information about addresses.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinAddressInfo('mainnet', '1DBrYbe5U7LGDcHA5tiLCxivZ7JZAGqGhJ').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
The Generate Address endpoint allows you to generate private-public key-pairs along with an associated public address.
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.generateBitcoinAddress('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
The Address Transactions Endpoint returns all information available about a particular address, including an array of complete transactions.
network String Network name (mainnet or testnet)address String Bitcoin addressindex (optional) [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number Offset results. Default value is 0limit (optional) [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number Limit results. Default limit is 50const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinAddressTransactions('mainnet', '3DrVotri9Rq2xcHqCMKpVUoyU6pvoWRtY3', 0, 10).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create Bitcoin Wallet
network String Network name (mainnet or testnet)name String Wallet nameaddresses Array<String> Array of addresses that will be added to walletconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
var addresses = ["1MfyBywPTSj9aAPr8cccCTcch71fd4vkDA", "1B5WsYR8m4axbmEMMifveDL2gtZjtpaFr5", "1KRYkrh3dAkeBWPwxDZhrz9u8xf5NRK9UH"];
caClient.createBitcoinWallet('mainnet', 'myWallet', addresses).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create Bitcoin HD Wallet
network String Network name (mainnet or testnet)name String Wallet nameaddressCount Number Number of addresses that should be generated in new walletpassword String Wallet passwordconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.createBitcoinHDWallet('mainnet', 'myHDWallet', 5, 'jr9023kes%kj').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
List Wallets
network String Network name (mainnet or testnet)hd Boolean False for normal wallets, true for HD walletsconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.listBitcoinWallets('mainnet', true).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Get Wallet
network String Network name (mainnet or testnet)walletName String Wallet namehd Boolean False for normal wallets, true for HD walletsconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinWallet('mainnet', 'myHDWallet', true).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Add Addresses to Wallet
network String Network name (mainnet or testnet)walletName String Wallet nameaddresses Array<String> Array of addresses that will be added to walletconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.addAddressToBitcoinWallet('mainnet', 'myWallet', ['1Eeu3eC2b35LWtjXeRMJMSfrDnfDEjNwW6']).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Generate Address in Wallet
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.generateAddressInBitcoinWallet('mainnet', 'myWallet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Generate Address in HD Wallet
network String Network name (mainnet or testnet)walletName String Wallet nameaddressCount Number Number of addresses that should be generatedpassword String Wallet passwordconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.generateAddressInBitcoinHDWallet('mainnet', 'myHDWallet', 2, 'jr9023kes%kj').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Remove Addresses from Wallet
network String Network name (mainnet or testnet)walletName String Wallet nameaddress String Address which should be deletedconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.deleteAddressFromBitcoinWallet('mainnet', 'myWallet', '1GdnJh1r3xWsst7o7JXykgGD13AF4NSmh3').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Delete Wallet
network String Network name (mainnet or testnet)walletName String Wallet namehd Boolean False for normal wallets, true for HD walletsconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.deleteBitcoinWallet('mainnet', 'myWallet', false).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns detailed information about a given transaction based on its id.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinTransaction('mainnet', '54287345c01d64a3365166b380adf04e738ec52935f2751aead7ae60ff4fcb21').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns detailed information about a given transaction based on its hash and index of transaction in the block.
network String Network name (mainnet or testnet)blockHash String Block hashindex Number Index of the transaction in blockconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinTransactionByBlockIndex('mainnet', '0000000000000000002523785a5a3a0f4a04536baf589f9c5fbf2b6273daf62b', 3).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
The Transaction Index Endpoint by Index, Limit and Block Height returns detailed information about transactions for the block height defined, starting from the index defined up to the limit defined.
network String Network name (mainnet or testnet)blockHeight Number Block heightindex Number Index - start fromlimit Number Limit - up toconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinTransactionsByBlockIndex('mainnet', 553394, 0, 3).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns an array of the latest transactions relayed by nodes in a blockchain that haven’t been included in any blocks.
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinUnconfirmedTransactions('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns detailed information about a given set of transactions based on theirs hashes.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
var txs = ['54287345c01d64a3365166b380adf04e738ec52935f2751aead7ae60ff4fcb21', '4ed3bbc8297b69a002ac7dc5fcf0acf01f6ffd92871c1027061a7eabc1e74623'];
caClient.bitcoinTransactionTrace('mainnet', txs).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns an array of the latest transactions relayed by nodes in a blockchain that could be mined or not.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinLatestTransactions('mainnet', 10).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Returns an array of the latest transactions. By default it is for last 24 hours
network String Network name (mainnet or testnet)txsIncluded Boolean Whether transactions to be included in response. Default trueindex (optional) [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number Offset results. Default value is 0limit (optional) Number Limit. Default limit is 50const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.getBitcoinTransactionsHistory('mainnet', true, 0, 5).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create transaction
network String Network name (mainnet or testnet)inputs Array<Object> Array of objects (see example below)outputs Array<Object> Array of objects (see example below)fee Number Transaction feeconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
var inputs = [{
address: "2N4Peeewfgghac69z6evCAmab91oEuWmkgy",
value: 0.54
}, {
address: "2MuqsmttygX6RWkxS1MLjDgwJ2DavbG9JPu",
value: 1.0
}];
var outputs = [{
address: "2Mx93LzsoPWR8UmoJMBFnCb2KkCGt2Jg8Dd",
value: 1.54
}];
caClient.createBitcoinTransaction('testnet', inputs, outputs, 0.00001500).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Send Transaction
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
var toSend = '02000000013f810859c03252a897dc1f5707ed9a3a5234ec4ef0ddafca9d933a0d32375380000000006a4730440220789cf627bc7e84e97dae9e94b97f6a790492511ad0be63afe424953846f9306a02206b99656cc96e58a717d5f47126b2ba49d612d9ef5ffb2d8b707d64d7629a776d0121023cf830a861754675344b72f0ef3654d5d47f156f7800cc6926b10309acf68899ffffffff011ced3200000000001976a914b20ecbedbb8c648e263487d40ab234cecefd34d588ac00000000';
caClient.sendBitcoinTransaction('testnet', toSend).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Decode Raw Transaction
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
var txHex = '0200000005c1ab663c05cc557f522d55d42734eb3fe7bfacf3737cba5102233b312b0c95590000000000ffffffffbfd5dc9ac3129f2a9788d0ab2c201861790d66ce147bf6ebe8ee44019b69ed790100000000ffffffff2837839555246cc3f0f9374f73030341d641f3beae71eeafb2461f8ba8daa1d40000000000ffffffffbe23166dca2f0b9a24d9704e5e6ecfe3e57265cda29468e68c19644d24e1f1c70000000000ffffffff41994176b4bb3f00bb128a982b907e0a3b139ac02d90253c61815dea3d16f98d0000000000ffffffff0140420f00000000001976a9141a96349a5025735fe18f3e783098e471edbad83388ac00000000';
caClient.decodeRawBitcoinTransaction('mainnet', txHex).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create Payment
network String Network name (mainnet or testnet)fromAddress String Destination bitcoin addresstoAddress String Target bitcoin addresscallbackURL String Callback URLwalletName String Wallet created by currentpassword String Wallet passwordconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinCreatePayment('mainnet', '12CHjjowV5koCpyMXHeYFhMQzd4KE6JUdF', '1DoAHYHRd72RBbScbr678vXhAwHPPfhY34', 'your callback url', 'myHDWallet', 'jr9023kes%kj').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
To list your currently active payment forwarding addresses
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinListPayment('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Delete Payment
network String Network name (mainnet or testnet)paymentID String Generated UUID when payment forwarding have been createdconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinDeletePayment('mainnet', '1f3e4771-ce6c-4b25-805b-cc27a38e2603').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Triggered for every new transaction CryptoAPIs receives before it's confirmed in a block, basically, for every unconfirmed transaction.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinCreateUnconfirmedTransactionWebHook('mainnet', 'your callback url').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Triggered for every new block.
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinCreateNewBlockWebHook('mainnet', 'your callback url').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create Confirmed Transaction WebHook
network String Network name (mainnet or testnet)callbackURL String Callback URLtransaction String Transaction IDconfirmations Number Confirmationsconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinCreateConfirmedTransactionWebHook('mainnet', 'your callback url', '56ee588e6ac4df324d5e1cdd0fa7d58a479295bad71f3c62865f1c302e0ca2a6', 5).then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Create Address Transaction WebHook
network String Network name (mainnet or testnet)callbackURL String Callback URLaddress String Bitcoin addressconst CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.bitcoinCreateAddressTransactionWebHook('mainnet', 'your callback url', '1GdnJh1r3xWsst7o7JXykgGD13AF4NSmh3').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
List all web hooks that you have created.
network String Network name (mainnet or testnet)const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.listAllBitcoinHooks('mainnet').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
Delete a WebHook by WebHook ID
const CryptoApis = require('cryptoapis.io');
const apiKey = 'your API key';
var caClient = new CryptoApis(apiKey);
caClient.deleteBitcoinWebHook('mainnet', '232c9f47-ff47-401c-9681-9d854e497c8a').then(function(result) {
console.log(result);
}, function(error) {
console.log(error);
});
MIT
FAQs
Crypto APIs 1.0 SDK
The npm package cryptoapis.io receives a total of 56 weekly downloads. As such, cryptoapis.io popularity was classified as not popular.
We found that cryptoapis.io demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.