Cryptoracle Open API (v1.1)

Cryptoracle Open API

Welcome to the Cryptoracle developer documentation! Cryptoracle provides a range of feature-rich API interfaces through which you can easily obtain various metric data and achieve efficient integration and interaction with the Cryptoracle system. The API root endpoint URL is https://service.cryptoracle.network/openapi/v1arrow-up-right

ChangeLog

We improve our data by providing new indicators, releasing new API features, and fixing bugs.

Introduction

Cryptoracle provides a full suite of API services, with CO series data covering basic information of cryptos and their private domain-related information. It can deeply analyze discussion trends, user behavior, and semantic insights into dimensions such as communities, community users, cryptocurrencies, and events, helping to build a comprehensive understanding of the private domain of the entire crypto ecosystem.

Supported Token List

#

Name

Token

1

Bitcoin

BTC

2

Ethereum

ETH

3

XRP

XRP

4

BNB

BNB

5

Solana

SOL

6

USDC

USDC

7

TRON

TRX

8

Dogecoin

DOGE

9

Cardano

ADA

10

Sui

SUI

11

Bitcoin Cash

BCH

12

Chainlink

LINK

13

Avalanche

AVAX

14

Stellar

XLM

15

Shiba Inu

SHIB

16

Toncoin

TON

17

Litecoin

LTC

18

Hedera

HBAR

19

Polkadot

DOT

20

Uniswap

UNI

21

Pepe

PEPE

22

Aave

AAVE

23

Bittensor

TAO

24

Aptos

APT

25

NEAR Protocol

NEAR

26

Internet Computer

ICP

27

Ethereum Classic

ETC

28

Ondo

ONDO

29

World Liberty Financial USD

USD1

30

POL (prev. MATIC)

POL

31

VeChain

VET

32

OFFICIAL TRUMP

TRUMP

33

Render

RENDER

34

Ethena

ENA

35

Artificial Superintelligence Alliance

FET

36

Arbitrum

ARB

37

Cosmos

ATOM

38

Filecoin

FIL

39

Algorand

ALGO

40

Worldcoin

WLD

41

First Digital USD

FDUSD

42

Sei

SEI

43

Bonk

BONK

44

Jupiter

JUP

45

Quant

QNT

46

Four

FORM

47

Injective

INJ

48

Celestia

TIA

49

Pudgy Penguins

PENGU

50

Virtuals Protocol

VIRTUAL

51

Stacks

STX

52

Kaia

KAIA

53

Optimism

OP

54

PAX Gold

PAXG

55

Sonic

S

56

dogwifhat

WIF

57

The Graph

GRT

58

Immutable

IMX

59

Nexo

NEXO

60

PancakeSwap

CAKE

61

Vaulta

A

62

FLOKI

FLOKI

63

Jito

JTO

64

Theta Network

THETA

65

Curve DAO Token

CRV

66

Ethereum Name Service

ENS

67

Zcash

ZEC

68

Lido DAO

LDO

69

Maple Finance

SYRUP

70

Gala

GALA

71

DeXe

DEXE

72

The Sandbox

SAND

73

IOTA

IOTA

74

JasmyCoin

JASMY

75

Tezos

XTZ

76

Pyth Network

PYTH

77

Raydium

RAY

78

Pendle

PENDLE

79

Flow

FLOW

80

Decentraland

MANA

81

TrueUSD

TUSD

82

THORChain

RUNE

83

ApeCoin

APE

84

Kava

KAVA

85

Movement

MOVE

86

Reserve Rights

RSR

87

Starknet

STRK

88

dYdX

DYDX

89

Compound

COMP

90

SuperVerse

SUPER

91

Neo

NEO

92

MultiversX

EGLD

93

Conflux

CFX

94

eCash

XEC

95

KAITO

KAITO

96

Axie Infinity

AXS

97

EigenLayer

EIGEN

98

ether.fi

ETHFI

99

JUST

JST

100

Chiliz

CHZ

101

Arweave

AR

102

ZKsync

ZK

103

Sun [New]

SUN

104

Axelar

AXL

105

Wormhole

W

106

Amp

AMP

107

Terra Classic

LUNC

108

Trust Wallet Token

TWT

109

Gnosis

GNO

110

FTX Token

FTT

111

Decred

DCR

112

Livepeer

LPT

113

Turbo

TURBO

114

Dash

DASH

115

1inch Network

1INCH

116

Golem

GLM

117

Theta Fuel

TFUEL

118

Peanut the Squirrel

PNUT

119

SafePal

SFP

120

Convex Finance

CVX

121

Zilliqa

ZIL

122

LayerZero

ZRO

123

Mina

MINA

124

Kusama

KSM

125

Qtum

QTUM

126

MANTRA

OM

127

IoTeX

IOTX

128

Berachain

BERA

129

Ravencoin

RVN

130

Synthetix

SNX

131

Basic Attention Token

BAT

132

Astar

ASTR

133

Neiro (First Neiro On Ethereum)

NEIRO

134

Gas

GAS

135

0x Protocol

ZRX

136

Notcoin

NOT

137

Oasis

ROSE

138

VeThor Token

VTHO

139

yearn.finance

YFI

140

Blur

BLUR

141

NEXPACE

NXPC

142

Alchemy Pay

ACH

143

Siacoin

SC

144

Sahara AI

SAHARA

145

SushiSwap

SUSHI

146

SPACE ID

ID

147

Nervos Network

CKB

148

Threshold

T

149

Celo

CELO

150

ORDI

ORDI

151

FUNToken

FUN

152

Banana For Scale

BANANAS31

153

Holo

HOT

154

Ankr

ANKR

155

Harmony

ONE

156

GMX

GMX

157

CoW Protocol

COW

158

Prom

PROM

159

Solayer

LAYER

160

DigiByte

DGB

161

Kamino Finance

KMNO

162

ICON

ICX

163

GMT

GMT

164

Vana

VANA

165

WOO

WOO

166

Kadena

KDA

167

aixbt

AIXBT

168

Polymesh

POLYX

169

Enjin Coin

ENJ

170

Mask Network

MASK

171

Gravity (by Galxe)

G

172

Babylon

BABY

173

Horizen

ZEN

174

Orca

ORCA

175

io.net

IO

176

AWE

AWE

177

Nano

XNO

178

Request

REQ

179

Solar

SXP

180

Liquity

LQTY

181

Magic Eden

ME

182

COTI

COTI

183

Ontology

ONT

184

BOOK OF MEME

BOME

185

Terra

LUNA

186

Rocket Pool

RPL

187

Hive

HIVE

188

Osmosis

OSMO

189

SKALE

SKL

190

Storj

STORJ

191

Arkham

ARKM

192

Big Time

BIGTIME

193

Altlayer

ALT

194

Pixels

PIXEL

195

Stratis [New]

STRAX

196

Loopring

LRC

197

Space and Time

SXT

198

Tellor

TRB

199

Metis

METIS

200

UMA

UMA

CO Datapack - Metrics Overview

ADS_COIN_METRICS

Name

Description

Window

Version

CO-A-01-01

Ranking of token mentions across social platforms (Twitter, Telegram, Discord, etc.) within specified timeframes (daily/hourly). Reflects relative distribution of market attention.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-02

Measures the magnitude of change in a token’s popularity ranking compared to the previous period (daily/hourly), quantifying the velocity of market attention shift.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-03

Total valid messages in coin-specific communities (official groups, forums) during statistical period, reflecting community activity level.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-04

Total user interactions (likes, shares, replies, quotes) in coin-related communities, quantifying engagement depth.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-05

Absolute mention count across all platforms including names, tickers, and related keywords.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-07

Represents the total number of unique users who mentioned a specific token across social platforms within a given time period — i.e., the count of distinct user IDs that referred to the token (including its name, ticker, or nickname).

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-08

Represents the number of communities (active groups or channels) that mention a given token at least once within a specified time window. This indicator measures the breadth of token dissemination and the scope of topic diffusion, helping to distinguish between localized hype (“single-point bursts”) and broad market attention. It can be used in conjunction with total mentions and unique user counts to construct community diffusion models.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-01-09

Represents the proportion of a token’s total mentions relative to the overall mentions across all tokens within a specified time period. This indicator measures the token’s relative popularity within overall community activity. The value ranges from 0 to 1, with higher values indicating greater social attention toward the token during that period.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-02-01

Within a specified time window, this indicator aggregates all positive sentiment expressions related to a given token and applies influence-based weighting (e.g., by follower count, activity level, or community role) to compute the proportion of positive sentiment within the token’s overall sentiment distribution.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-02-02

Within a specified time window, this indicator aggregates all negative sentiment expressions related to a given token and applies influence-based weighting (e.g., by follower count, activity level, or community role) to calculate the proportion of negative sentiment within the token’s overall sentiment distribution.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-02-03

The difference between the proportion of positive emotions and the proportion of negative emotions reflects the directionality intensity of market sentiment.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-02-04

In the user sentiment scoring system (such as -1~+1 emotion values), identify emotional expressions at the distribution extremes (such as above +0.8 extreme positive or below -0.8 extreme negative), and calculate their proportion after weighting by user influence.

Daily, 4H, 1H, 15M

v1.0.0

CO-A-02-05

Measure whether the emotional expressions of different users towards a certain cryptocurrency tend to be consistent within the same time window.

Daily, 4H, 1H, 15M

v1.0.0

DIM_COIN_HIS

Name

Description

Window

Version

CO-B-01-01

The Token Market Cap Tier categorizes crypto assets based on their market capitalization scale and asset characteristics, helping users assess a token’s size, stability, and investment profile. This label integrates metrics such as market cap and volatility, classifying cryptocurrencies into tiers such as Whale Tokens, Major Tokens, Mid-Cap Tokens, Micro Tokens, and Stablecoins.

Daily

v1.0.0

CO-B-01-03

The Technical Consensus Mechanism identifies the primary consensus algorithm adopted by a project’s underlying blockchain network, which directly influences its performance, security, degree of decentralization, and energy efficiency — key technical characteristics that define the network’s foundational architecture.

Daily

v1.0.0

CO-B-01-04

The Ecosystem Affiliation Tag defines a project’s position and role within the broader crypto industry ecosystem. By combining primary and secondary tags, it maps the project’s placement across technology stacks and application domains. The primary tag represents the project’s core functional domain, while the secondary tag denotes related but non-exclusive application scenarios.

Daily

v1.0.0

DIM_COMMUN_HIS

Name

Description

Window

Version

CO-B-03-01

The community scale is a label used to categorize and grade community sizes based on the number of members on different social platforms, reflecting the community's influence and reach.

Daily

v1.0.0

CO-B-03-05

The Speech Distribution Tag quantifies the concentration of user-generated content within a community, indicating whether discussions are dominated by a few high-influence participants or driven by a wider base of retail contributors.

Daily

v1.0.0

CO-B-03-06

The Active Timezone Tag identifies the peak activity periods of community members across different regional time zones (e.g., Asia, Europe, North America), reflecting the community’s geographical engagement patterns and regional activity dynamics within the crypto ecosystem.

Daily

v1.0.0

Quick Start Guide

For developers eager to hit the ground running with the Cryptoracle Open API here are a few quick steps to make your first call with the API.

  1. Obtain API Access Credentials Apply for the following key information via email (prddev@cryptoracle.network):

apiKey: API access identity identifier, 16-character stringSignature Secret Key: Used for request signature verificationData Secret Key: Used for data encryption and decryptionInitialization Vector (IV): Used in conjunction with the data key for encryption and decryption operations

  1. Test the API

Use the provided code examples to initiate a test request in your local environment. Ensure that you replace the placeholders in the examples with your own key information to verify that the interface can respond normally.

  1. Integrate into Your Application

After successfully completing the test, you can start building your application logic according to the detailed documentation of this API. Familiarizing yourself with the functions and parameter structures of each interface will help you use the service more efficiently.

  1. Flexible Combination of Indicator Calls

Based on your business needs, freely combine different interfaces or indicators to achieve customized data query and analysis functions.

Note: Currently, CORS configuration prohibits the use of JavaScript to initiate HTTP requests in the client. Do not hard-code the keys in your client-side code; instead, store them in backend environment variables or key management services.

Python Encryption Utility Demo

AesUtil.pyarrow-up-right

Java Signature Verification Demo

AesUtil.javaarrow-up-right

HmacUtil.javaarrow-up-right

Authentication

Encryption

All Cryptoracle API endpoints communicate over the HTTP(S) protocol. Data transmission is standardized in JSON (JavaScript Object Notation) format, with clients specifying the data type via the Content-Type: application/json request header. The server responds using the same format.1. Signature AlgorithmTo ensure request authenticity and data integrity, Cryptoracle implements an HMAC-MD5–based signature mechanism. The signing process proceeds as follows:

  • Concatenate all public parameters in the request (excluding empty values and the sign field) in the format key=value;

  • Sort all concatenated key-value pairs in ascending alphabetical order by key (compare subsequent letters if the first is identical);

  • Join the sorted pairs with an ampersand &, e.g.:

  • Apply the HMAC-MD5 algorithm to this string using the signature secret key (sigsecret) provided by Cryptoracle;

  • The resulting MD5 digest is used as the sign parameter in the API request.

2. Data EncryptionTo protect data confidentiality during transmission, Cryptoracle adopts the following encryption configuration:

  • Algorithm: AES (Advanced Encryption Standard)

  • Key Length: 128 bits

  • Mode: CBC (Cipher Block Chaining)

  • Padding: PKCS5Padding

  • Key & Initialization Vector (IV): Provided by Cryptoracle

Request payloads must be encrypted using the above settings. The server will decrypt the data using the same key and IV.By combining HMAC-MD5 signature verification and AES encryption, Cryptoracle ensures both the security and integrity of all API communications.

Example

apiKey:cryptoracle secretKey: cryptoracletest1dataSecret:cryptoracletest1 dataIV: cryptoracletest1Example plaintext:

Example ciphertext:

Example signature:

Response example (ciphertext):

Response example (plaintext):

Error Codes

The Cryptoracle Open API uses standard HTTP status codes to indicate success or failure. 200 represents success, 2xx represents a user error (such as a problem with your key), and 4xx represents a problem with our API.The following table describes status and error codes returned by API. The code field contains the status code and the msg field contains the type of response.

Code

Type

Description

200

success

Request was successful.

201

bad_request

Some required parameter is missing or has the wrong value.

202

unauthorized

Internal authorization failed. It might mean missing or wrong credentials.

203

data error

Missing business data

204

forbidden

It means you don't have an access to the requested endpoint.

205

Endpoint forbidden

No permission to access the indicator

403

signature error

Signature verification failed

IP Whitelist

When calling the Cryptoracle API, the system only allows requests initiated from addresses in your pre-configured IP whitelist. To enhance security, you can provide Cryptoracle with multiple trusted IP addresses; all requests from these IPs will be processed normally, while requests from other sources will be rejected. Please ensure that your service's export IP is correctly configured in the whitelist to avoid connection issues.- Configuration Method: Submit the IP addresses to be added to the whitelist via email (prddev@cryptoracle.network)-Effective Time: Takes effect within 1-2 working days after submission- Modification Process: If you need to add or remove an IP, repeat the above email application process

API List

This interface serves as the unified entry point for fetching metric data from Cryptoracle. It supports calling multiple metrics with a single request and allows for the input of multiple tokens and time ranges as common parameters. It is suitable for batch query scenarios and helps reduce the overhead of multiple calls.注意事项- All time fields must use the current Beijing time;- Multiple cryptos and multiple indicators can be requested at once to improve query efficiency, with a maximum of 2000 records returned per API call;- If a specific indicator requires additional parameters, please pass them in according to the structure in extraParams;- Ensure that the indicator codes in the endpoints are correct, otherwise it may result in request failure or empty data;- This API design aims to enhance the flexibility and efficiency of API calls in scenarios involving multiple indicators and multiple currencies. Request addresspost /v1/endpointPublic Parameters:

Parameter Name

Type

Required

Description

token

List

Yes

Collection of crypto names, such as:["BTC","ETH"]

startTime

string

Yes

Start time, yyyy-MM-dd HH:mm:ss

endTime

string

Yes

End time, yyyy-MM-dd HH:mm:ss

timeType

string

Yes

Time granularity, optional values are 15m (15 minutes), 1h (1 hour), 4h (4 hours), 1d (1 day), used to specify the time interval for data statistics

endpoints

List

Yes

Specify indicators, such as:["CO-A-01-01","CO-A-01-02"]

tags

List

Yes

Specify tags, such as:["CO-B-03-01","CO-B-03-05"]

extraParams

List

No

List of additional parameters for passing non-public parameters (specific details see each metric definition)

Expand parameter structure (for extraParams)

Parameter Name

Type

Required

Description

endpoint

String

No

Specify the indicator to be passed as a parameter, such as CO-A-01-01

param

Object

No

The expansion parameter object is required for the current indicator. Please refer to the parameter definition of the corresponding indicator for specific content.

Responses

Parameter Name

Type

Description

token

string

Token name

startTime

string

Start time

endTime

string

End Time

timeType

string

Time granularity aligns with the request.

endPoints

List

Indicator set

tags

List

Tag set

Description of Indicator Set

Parameter Name

Type

Description

startTime

string

Start time, yyyy-MM-dd HH:mm:ss

endTime

string

End time, yyyy-MM-dd HH:mm:ss

data

List

[{"endpoint": "CO-A-01-01","value": "1"},{"endpoint": "CO-A-01-02","value": "1.22"}]

Example of business request parameters before encryption

Example of encrypted request parameters

Return ValueExample of Responding Encrypted Data

Response to decrypted encrypted data example

Token Lists

Return the list of tokens supported by the systemRequest URLpost /v1/coin/listRequest data

Response data

Indicators

CO-A-01-01

Indicator Explanation: The frequency ranking of mentions for each token on social platforms (such as Twitter, Telegram, Discord, etc.) within a specified time period (day/hour) during the monitoring period. Reflects the relative distribution of market attention. Request data

Response data

CO-A-01-02

Indicator Explanation:Measures the magnitude of change in a token’s popularity ranking compared to the previous period (daily/hourly), quantifying the velocity of market attention shift. Request data

Response data

CO-A-01-03

Indicator Explanation: The total number of effective messages posted in communities (official groups, topic forums, etc.) associated with a specific currency during the statistical period, reflecting the activity level of the community. Request data

Response data

CO-A-01-04

Indicator Explanation: The total number of user interactions within a crypto community, including likes, shares, replies, quotes, etc., quantifying the depth of community participation. Request data

Response data

CO-A-01-05

Indicator Explanation: The number of times a single token is mentioned across all social platforms, including mentions of the name, code, nickname, and related keywords. Request data

Response data

CO-A-01-07

Indicator Explanation: The total number of times a single token is mentioned by different users across the entire social media platform; that is, how many unique user IDs mention the token during the selected time period (including keywords such as name, code, nickname, etc.). Request data

Response data

CO-A-01-08

Indicator Explanation:Represents the number of communities (active groups or channels) that mention a given token at least once within a specified time window. This indicator measures the breadth of token dissemination and the scope of topic diffusion, helping to distinguish between localized hype (“single-point bursts”) and broad market attention. It can be used in conjunction with total mentions and unique user counts to construct community diffusion models. Request data

Response data

CO-A-01-09

Indicator Explanation:Represents the proportion of a token’s total mentions relative to the overall mentions across all tokens within a specified time period. This indicator measures the token’s relative popularity within overall community activity. The value ranges from 0 to 1, with higher values indicating greater social attention toward the token during that period. Request data

Response data

CO-A-02-01

Indicator Explanation:Within a specified time window, this indicator aggregates all positive sentiment expressions related to a given token and applies influence-based weighting (e.g., by follower count, activity level, or community role) to compute the proportion of positive sentiment within the token’s overall sentiment distribution. Request data

Response data

CO-A-02-02

Indicator Explanation:Within a specified time window, this indicator aggregates all negative sentiment expressions related to a given token and applies influence-based weighting (e.g., by follower count, activity level, or community role) to calculate the proportion of negative sentiment within the token’s overall sentiment distribution. Request data

Response data

CO-A-02-03

Indicator Explanation:The difference between the proportion of positive emotions and the proportion of negative emotions reflects the directionality intensity of market sentiment. Request data

Response data

CO-A-02-04

Indicator Explanation:In the user sentiment scoring system (such as -1~+1 emotion values), identify emotional expressions at the distribution extremes (such as above +0.8 extreme positive or below -0.8 extreme negative), and calculate their proportion after weighting by user influence. Request data

Response data

CO-A-02-05

Indicator Explanation:Measure whether the emotional expressions of different users towards a certain token tend to be consistent within the same time window. Request data

Response data

Tags

CO-B-03-01

Indicator Explanation:The community scale is a label used to categorize and grade community sizes based on the number of members on different social platforms, reflecting the community's influence and reach. Request data

Response data

CO-B-03-05

Indicator Explanation:The Speech Distribution Tag quantifies the concentration of user-generated content within a community, indicating whether discussions are dominated by a few high-influence participants or driven by a wider base of retail contributors. Request data

Response data

CO-B-03-06

Indicator Explanation:The Active Timezone Tag identifies the peak activity periods of community members across different regional time zones (e.g., Asia, Europe, North America), reflecting the community’s geographical engagement patterns and regional activity dynamics within the crypto ecosystem. Request data

Response data

最后更新于