cryptocompare
1.0.0
CryptoCompare JavaScript API
npm install --save cryptocompare
注： cryptocompareはfetch()グローバルに定義されることに依存します。
これを電子で使用している場合、構成なしで動作するはずです。
node.jsでこれを使用している場合は、 node-fetchを使用する必要があります。
パッケージはAPIキーなしで動作しますが、IPの制限は時間とともにゆっくりと削減され、APIキーを作成するためにhttps://www.cryptocompare.com/cryptopian/api-keysに移動し、「読み取り」を確認してくださいすべての価格ストリーミングとポーリングのエンドポイント「許可」
例：
global . fetch = require ( 'node-fetch' )
const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )coinList()すべての暗号通貨の現在のリストと、各コインに関する次の情報を取得します。
coinList()
No parametersReturns （オブジェクト）...BaseImageUrl （String）ImageUrlフィールドのすべての画像のベースURL（https://www.cryptocompare.com）、BaseLinkUrl URLフィールドからのすべてのリンクのベースURL（https://www.cryptocompare.com）Data （オブジェクト）には、各コインに関する以下の侵害が含まれています。Id （文字列）Url （文字列）URL。 （例： /coins/eth/overview ）urlはhttps://www.cryptocompare.comに追加する必要があります。ImageUrl （String）URLコインロゴ画像を取得します。 （例： /media/351001/404.png ）。 URLはhttps://www.cryptocompare.comに追加する必要があります。Name （文字列）指定された暗号通貨のティッカー名。Symbol （文字列）指定された暗号通貨のティッカーシンボル（通常は名前と同じ）。CoinName （文字列）指定された暗号通貨の名前。FullName （文字列）シンボル（Ex： Ethereum (ETH) ）と合わせた指定された暗号通貨の名前。Algorithm （文字列）そのコインの名前の暗号化アルゴリズム。ProofType （文字列）暗号通貨の証明タイプ。ProofType （文字列）暗号通貨の証明タイプ。FullyPremined （文字列）コインが初めてプレミングされた場合、「0」を返した場合、「1」を返します。TotalCoinSupply （文字列）暗号通貨の合計供給。PreMinedValue （STRING）Primedined Coinsの値。TotalCoinsFreeFloat （string）SortOrder （文字列）注文CryptoCompareは、内部システム内のコインをランク付けします。Sponsored （ブール）は、コインがcryptocompareによってスポンサーになっている場合にtrueですが、それ以外の場合はfalseです。 const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . coinList ( )
. then ( coinList => {
console . log ( coinList )
// ->
// {
// BTC: {
// Id: "1182",
// Url: "/coins/btc/overview",
// ImageUrl: "/media/19633/btc.png",
// Name: "BTC",
// Symbol: "BTC",
// CoinName: "Bitcoin",
// FullName: "Bitcoin (BTC)",
// Algorithm: "SHA256",
// ProofType: "PoW",
// FullyPremined: "0",
// TotalCoinSupply: "21000000",
// PreMinedValue: "N/A",
// TotalCoinsFreeFloat: "N/A",
// SortOrder: "1",
// Sponsored: false
// },
// ETH: {...},
// }
} )
. catch ( console . error )exchangeList()CryptoCompareが統合したすべての交換を返します。
exchangeList()
No parametersReturns （オブジェクト） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . exchangeList ( )
. then ( exchangeList => {
console . log ( exchangeList )
// {
// "Cryptsy":
// {
// "42":["BTC","XRP"],
// "EMC2":["BTC","XRP"],
// "POINTS":["BTC"],
// "VTC":["BTC","LTC","XRP"]
// ...
// }
// ...
// }
} )
. catch ( console . error )price()他の通貨で暗号通貨の現在の価格を取得します。
price(fsym, tsyms[, options])
fsym （string）tsyms （文字列の配列|文字列）からシンボルoptions （オブジェクト）tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。exchanges （文字列の配列|配列）は、価格データを取得するための交換。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Basic Usage:
cc . price ( 'BTC' , [ 'USD' , 'EUR' ] )
. then ( prices => {
console . log ( prices )
// -> { USD: 1100.24, EUR: 1039.63 }
} )
. catch ( console . error )
// Passing a single pair of currencies:
cc . price ( 'BTC' , 'USD' )
. then ( prices => {
console . log ( prices )
// -> { USD: 1100.24 }
} )
. catch ( console . error )priceMulti() price()のように機能しますが、それを除いて、シンボルのマトリックスを指定できます。
priceMulti(fsyms, tsyms[, options])
fsyms （文字列の配列|文字列）tsyms （文字列の配列|文字列）からシンボルoptions （オブジェクト）tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。exchanges （文字列の配列|配列）は、価格データを取得するための交換。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Basic Usage:
cc . priceMulti ( [ 'BTC' , 'ETH' ] , [ 'USD' , 'EUR' ] )
. then ( prices => {
console . log ( prices )
// -> { BTC: { USD: 1114.63, EUR: 1055.82 },
// ETH: { USD: 12.74, EUR: 12.06 } }
} )
. catch ( console . error )
// Passing a single pair of currencies:
cc . priceMulti ( 'BTC' , 'USD' )
. then ( prices => {
console . log ( prices )
// -> { BTC: { USD: 1114.63 } }
} )
. catch ( console . error )priceFull()他の通貨の暗号通貨のリストのすべての現在の取引情報（価格、vol、open、high、lowなど）を取得します。
priceFull(fsyms, tsyms[, options])
fsyms （文字列の配列|文字列）tsyms （文字列の配列|文字列）からシンボルoptions （オブジェクト）tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。exchanges （文字列の配列|配列）は、価格データを取得するための交換。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
cc . priceFull ( [ 'BTC' , 'ETH' ] , [ 'USD' , 'EUR' ] )
. then ( prices => {
console . log ( prices )
// {
// BTC: {
// USD: {
// TYPE: '5',
// MARKET: 'CCCAGG',
// FROMSYMBOL: 'BTC',
// TOSYMBOL: 'USD',
// FLAGS: '4',
// PRICE: 1152.42,
// LASTUPDATE: 1487865689,
// LASTVOLUME: 0.21,
// LASTVOLUMETO: 242.20349999999996,
// LASTTRADEID: 1224703,
// VOLUME24HOUR: 53435.45299122338,
// VOLUME24HOURTO: 60671593.843186244,
// OPEN24HOUR: 1119.31,
// HIGH24HOUR: 1170,
// LOW24HOUR: 1086.641,
// LASTMARKET: 'itBit',
// CHANGE24HOUR: 33.11000000000013,
// CHANGEPCT24HOUR: 2.958072383879366,
// SUPPLY: 16177825,
// MKTCAP: 18643649086.5
// },
// EUR: ...
// },
// ETH: ...
// }
} )
. catch ( console . error )priceHistorical()特定のタイムスタンプで他の通貨で暗号通貨の価格を取得します。価格は毎日の情報からのものです。したがって、要求されたタイムスタンプに基づいて、GMTの終わりに価格になります。
priceHistorical(fsym, tsyms, time[, options])
fsym （string）tsyms （文字列の配列|文字列）からシンボルtime （日付）日付options （オブジェクト）tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。exchanges （文字列の配列|配列）は、価格データを取得するための交換。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Basic Usage:
cc . priceHistorical ( 'BTC' , [ 'USD' , 'EUR' ] , new Date ( '2017-01-01' ) )
. then ( prices => {
console . log ( prices )
// -> { BTC: { USD: 997, EUR: 948.17 } }
} )
. catch ( console . error )generateAvg()要求されたペアの現在の取引情報（価格、vol、vol、open、high、lowなど）を計算します。
generateAvg(fsym, tsym, markets[, tryConversion])
fsym （string）tsym （String）からシンボルmarkets （配列）の市場の配列。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。）tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。 const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Basic Usage:
cc . generateAvg ( 'BTC' , 'USD' , [ 'Coinbase' , 'Kraken' , 'Bitstamp' , 'Bitfinex' ] )
. then ( data => {
console . log ( data )
// -> { MARKET: 'CUSTOMAGG',
// FROMSYMBOL: 'BTC',
// TOSYMBOL: 'USD',
// FLAGS: '2',
// PRICE: 1155.61,
// LASTUPDATE: 1488059738,
// LASTVOLUME: 0.25546663,
// LASTVOLUMETO: 294.93622433499996,
// LASTTRADEID: 26533969,
// VOLUME24HOUR: 27318.892083369985,
// VOLUME24HOURTO: 31652183.38370657,
// OPEN24HOUR: 1177.16,
// HIGH24HOUR: 1189.9,
// LOW24HOUR: 1110,
// LASTMARKET: 'Bitfinex',
// CHANGE24HOUR: -21.550000000000182,
// CHANGEPCT24HOUR: -1.830677223147251 }
} )
. catch ( console . error )topPairs()通貨のボリュームごとにトップペアを取得します。
topPairs(fsym[, limit])
fsym （string）limit （番号）は、受け取るペアの数を制限します（デフォルト5）。 const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
cc . topPairs ( 'BTC' , 2 )
. then ( pairs => {
console . log ( pairs )
// -> [ { exchange: 'CCCAGG',
// fromSymbol: 'BTC',
// toSymbol: 'JPY',
// volume24h: 235602.43493487104,
// volume24hTo: 31888554862.766888 },
// { exchange: 'CCCAGG',
// fromSymbol: 'BTC',
// toSymbol: 'USD',
// volume24h: 124504.4477389583,
// volume24hTo: 145514032.93780443 } ]
} )
. catch ( console . error )topExchanges()通貨ペアのボリュームごとにトップ交換を取得します。
topExchanges(fsym, tsym[, limit])
fsym （string）tsym （String）からシンボルlimit （番号）は、受け取った交換の数を制限します（デフォルト5）。 const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
cc . topExchanges ( 'BTC' , 'USD' , 2 )
. then ( exchanges => {
console . log ( exchanges )
// -> [ { exchange: 'Bitfinex',
// fromSymbol: 'BTC',
// toSymbol: 'USD',
// volume24h: 35239.36701090003,
// volume24hTo: 41472258.85534388 },
// { exchange: 'Bitstamp',
// fromSymbol: 'BTC',
// toSymbol: 'USD',
// volume24h: 19658.748675010014,
// volume24hTo: 23047071.74260772 } ]
} )
. catch ( console . error )topExchangesFull()通貨ペアのボリュームごとにトップ交換の完全なデータを取得します。
topExchangesFull(fsym, tsym[, limit])
fsym （string）tsym （String）からシンボルlimit （番号）は、受け取った交換の数を制限します（デフォルト5）。histoDay()毎日の歴史的データからオープン、ハイ、ロー、クローズ、ボリューム、およびボリュームを取得します。値は00:00 GMT時間に基づいています。
histoDay(fsym, tsym[, options])
fsym （string）tsym （String）からシンボルoptions （オブジェクト）aggregate （数）集合体。aggregatePredictableTimePeriods （boolean）は、予測可能な期間を生成します。allData （boolean）はすべてのデータを返します。toTs （number）最後のUnixタイムスタンプがデータを返します。limit （番号| 'none' ）は、ルックアップまでの日数を制限します。デフォルトは30です。文字列'none'に設定すると、利用可能なすべてのデータが取得されます。tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。timestamp （日付）デフォルトでは、 histoDay()過去数日間履歴データを取得します。 timestampオプションを使用して、履歴開始点を設定します。exchange （String）Exchangeから履歴データを取得します。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） cc . histoDay ( 'BTC' , 'USD' )
. then ( data => {
console . log ( data )
// -> [ { time: 1485388800,
// close: 915.65,
// high: 917.71,
// low: 893.81,
// open: 893.97,
// volumefrom: 35494.93,
// volumeto: 32333344.2 },
// ... ]
} )
. catch ( console . error )histoHour()時間ごとの履歴データからオープン、ハイ、ロー、クローズ、ボリューム、ボリューム、ボリュームを取得します。
histoHour(fsym, tsym[, options])
fsym （string）tsym （String）からシンボルoptions （オブジェクト）aggregate （数）集合体。aggregatePredictableTimePeriods （boolean）は、予測可能な期間を生成します。toTs （number）最後のUnixタイムスタンプがデータを返しますlimit （数）ルックアップまでの時間数を制限します。デフォルトは168です。tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。timestamp （日付）デフォルトでは、 histoHour()過去数時間の履歴データを取得します。 timestampオプションを使用して、履歴開始点を設定します。exchange （String）Exchangeから履歴データを取得します。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） cc . histoHour ( 'BTC' , 'USD' )
. then ( data => {
console . log ( data )
// -> [ { time: 1487448000,
// close: 1060.34,
// high: 1061.44,
// low: 1058.85,
// open: 1059.24,
// volumefrom: 739.6,
// volumeto: 790019.22 },
// ... ]
} )
. catch ( console . error )histoMinute()数分ごとに歴史的なデータからオープン、ハイ、ロー、クローズ、ボリューム、ボリューム、ボリュームを取得します。
histoMinute(fsym, tsym[, options])
fsym （string）tsym （String）からシンボルoptions （オブジェクト）aggregate （数）集合体。aggregatePredictableTimePeriods （boolean）は、予測可能な期間を生成します。toTs （number）最後のUnixタイムスタンプがデータを返しますlimit （番号）ルックアップの分数を制限します。デフォルトは1440です。tryConversion （Boolean）デフォルトでは、暗号が要求されたTosymbolに直接取引しない場合、BTCは変換に使用されます。 tryConversionをfalseに設定して、変換のためにBTCを使用して無効にします。timestamp （日付）デフォルトでは、 histoMinute()過去数分間履歴データを取得します。 timestampオプションを使用して、履歴開始点を設定します。exchange （String）Exchangeから履歴データを取得します。デフォルトでは、平均データが使用されます。 （ topExchanges()を使用した特定のペアのトップ交換のリストを取得できます。） cc . histoMinute ( 'BTC' , 'USD' )
. then ( data => {
console . log ( data )
// -> [ { time: 1487970960,
// close: 1171.97,
// high: 1172.72,
// low: 1171.97,
// open: 1172.37,
// volumefrom: 25.06,
// volumeto: 29324.12 },
// ... ]
} )
. catch ( console . error )newsList()CryptoCompareが統合したプロバイダーからニュース記事を返します。
newsList(lang[, options])
lang （String）Preferred Language-英語（EN）またはポルトガル語（PT）options （オブジェクト）feeds （文字列の配列|配列）特定のニュースフィードは、空の場合、すべてのデフォルトからニュースを取得します。 （ newsFeedsAndCategories().Feeds ..）categories （文字列の配列|配列）ニュース記事のカテゴリは、空の場合はデフォルトですべてを返します。 （ newsFeedsAndCategories().Categoriesでニュースカテゴリのリストを取得できます。）excludeCategories （文字列の配列|配列）ニュース記事カテゴリは、結果から除外するカテゴリを空にしても、デフォルトはありません。 （ newsFeedsAndCategories().Categoriesでニュースカテゴリのリストを取得できます。）lTs （日付）は、そのタイムスタンプの前にニュースを返します const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Basic Usage:
cc . newsList ( 'EN' )
. then ( newsList => {
console . log ( newsList )
//[
// {
// id: "708235"
// guid: "https://www.cryptoglobe.com/latest/2018/11/china-cryptocurrency-mining-machines-are-reportedly-being-sold-according-to-their-weight/"
// published_on: 1542886256
// imageurl: "https://images.cryptocompare.com/news/cryptoglobe/fwMg0080000.jpeg"
// title: "China: Cryptocurrency Mining Machines Reportedly Being Sold According to Their Weight"
// url: "https://www.cryptoglobe.com/latest/2018/11/china-cryptocurrency-mining-machines-are-reportedly-being-sold-according-to-their-weight/"
// source: "cryptoglobe"
// body: "Cryptocurrency mining machines are reportedly being sold in China according to their weight as miners who haven’t been able to make a profit are seemingly getting rid of their old models to get some of their investment back."
// tags: ""
// categories: "Mining|Asia|Business"
// upvotes: "0"
// downvotes: "0"
// lang: "EN"
// source_info: {
// name: "CryptoGlobe"
// lang: "EN"
// img: "https://images.cryptocompare.com/news/default/cryptoglobe.png"
// }
// }
// ....
//]
} )
. catch ( console . error )newsFeedsAndCategories()CryptoCompareが統合したすべてのニュースフィード（プロバイダー）とカテゴリの完全なリストを返します。
newsFeedsAndCategories()
No parametersReturns （オブジェクト） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . exchangeList ( )
. then ( newsFeedsAndCategories => {
console . log ( newsFeedsAndCategories )
// {
// "Categories":
// [
// {
// categoryName: "BTC"
// wordsAssociatedWithCategory: ["BTC","BITCOIN", "SATOSHI"]
// }
// ...
// ]
// "Feeds":
// [
// {
// key: "cryptocompare"
// name: "CryptoCompare"
// lang: "EN"
// img: "https://images.cryptocompare.com/news/default/cryptocompare.png"
// }
// ...
// ]
// }
} )
. catch ( console . error )constituentExchangeList()リクエスト機器のすべての構成要素交換を返します。
constituentExchangeList([options])
options （オブジェクト）instrument （文字列）平均楽器のタイプ。Returns （オブジェクト） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . constituentExchangeList ( )
. then ( exchanges => {
console . log ( exchanges )
// {
// "ABCC": {
// "includeAll": false,
// "onlyPairs": {
// "CNN~BTC": true,
// "TNS~BTC": true,
// "TTU~USDT": true,
// "XMX~BTC": true,
// "GUSD~USDT": true
// }
// },
// "ACX": {
// "includeAll": true,
// "onlyPairs": {}
// },
// ...
// }
} )
. catch ( console . error )latestSocial()要求されたコインの最新のソーシャル統計データを返します。
注：有効なAPIキーが必要です。
latestSocial([options])
options （オブジェクト）coinId （number）コインのID。Returns （オブジェクト） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . latestSocial ( )
. then ( social => {
console . log ( social )
// {
// "General": {
// "Points": 7431355,
// "Name": "BTC",
// "CoinName": "Bitcoin",
// "Type": "Webpagecoinp"
// },
// "CryptoCompare": {
// ...
// },
// "Twitter": {
// ...
// },
// "Reddit": {
// ...
// },
// "Facebook": {
// ...
// },
// "CodeRepository": {
// ...
// }
// }
} )
. catch ( console . error )histoSocial()要求されたコインのソーシャル統計データを返します。
注：有効なAPIキーが必要です。
histoSocial(timePeriod[, options])
timePeriod （String）期間 - 「日」または「時間」options （オブジェクト）coinId （number）コインのID。aggregate 。aggregatePredictableTimePeriods （BOOLEAN）は、 aggregate PARAMが含まれている場合にのみ使用されます。 FALSEの場合、呼び出しがいつ行われるかに基づいてタイムスロットを作成します。limit （number）データポイントの数を返します。toTs （number）最後のUnixタイムスタンプがデータを返しますReturns （オブジェクトの配列） const cc = require ( 'cryptocompare' )
cc . setApiKey ( '<your-api-key>' )
// Usage:
cc . histoSocial ( 'hour' )
. then ( socialStats => {
console . log ( socialStats )
// [
// {
// "time": 1548640800,
// "comments": 229133,
// "posts": 89997,
// "followers": 64128,
// "points": 6144455,
// "overview_page_views": 22335644,
// "analysis_page_views": 955496,
// "markets_page_views": 1402190,
// "charts_page_views": 7527086,
// "trades_page_views": 673204,
// "forum_page_views": 6585840,
// "influence_page_views": 55903,
// "total_page_views": 39535363,
// "fb_likes": 40054,
// "fb_talking_about": 92,
// "twitter_followers": 844049,
// "twitter_following": 165,
// "twitter_lists": 6631,
// "twitter_favourites": 1000,
// "twitter_statuses": 20316,
// "reddit_subscribers": 1013891,
// "reddit_active_users": 4365,
// "reddit_posts_per_hour": 3.77,
// "reddit_posts_per_day": 90.46,
// "reddit_comments_per_hour": 68.39,
// "reddit_comments_per_day": 1641.34,
// "code_repo_stars": 44353,
// "code_repo_forks": 25367,
// "code_repo_subscribers": 4179,
// "code_repo_open_pull_issues": 330,
// "code_repo_closed_pull_issues": 11847,
// "code_repo_open_issues": 903,
// "code_repo_closed_issues": 5187
// }
// ]
} )
. catch ( console . error ) mit
