Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 个端点 15 个分组 每次调用均返回 X-Quota-* http://localhost/api/v1

所有端点均位于 /api/v1 之下,需要一个具备 data-api 权限的 Bearer 密钥——请在你的开发者控制台中创建。

你的首次调用:

curl https://bitculator.com/api/v1/prices/bitcoin \
  -H "Authorization: Bearer YOUR_API_KEY"

响应均为 JSON 格式。价格、汇率与供应量为十进制字符串(浮点数无法承载市场所需精度);计数与分析值则为数字。每个响应都会在 X-Quota-Limit / X-Quota-Used / X-Quota-Reset 响应头中携带你的实时配额,错误始终采用 {"error": {"code", "message", "details"}} 信封结构。

Data API 拥有独立的按月配额,与你的 API 套餐绑定,并与嵌入组件完全分离。per_page 上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。

身份验证

要对请求进行身份验证,请在每个请求中包含 Authorization: Bearer {YOUR_API_KEY} 请求头。

请在你的开发者控制台中创建 Data API 密钥——密钥仅支持 Bearer 方式并具备 data-api 权限。请将其保存在服务器端;它们绝不应用于客户端嵌入。

授权请求头
创建密钥 →
Bearer
bc_••••••••••••••••

每个请求均以 Authorization: Bearer {YOUR_API_KEY} 的形式发送。

9 个端点

币种

排名的币种与代币市场数据:分页列表、单币种详情、涨跌榜(涨幅榜/跌幅榜)、最新添加、热门,以及按币种的时间序列。价格、市值与供应量为十进制字符串(浮点数无法承载市场所需精度);百分比涨跌幅、排名与计数则为数字。

币种列表

带价格、筛选与选择器的排名币种,采用 Laravel 的 links + meta 信封分页。价格、市值与 circulating_supply 为十进制字符串;涨跌幅与排名为数字。

GET
http://localhost/api/v1/coins
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

最新添加的币种

最新上架——按 status_updated_at 排序(即转为活跃的时间戳;created_at 为抓取日期,可能远早于上架时间任意时长)。行数据结构与分页信封同 List coins

GET
http://localhost/api/v1/coins/recently-added
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/recently-added?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

涨幅榜

interval 时间窗内涨幅最大的币种(默认 24h,或 7d)。行数据结构与分页信封同 List coins

GET
http://localhost/api/v1/coins/gainers
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/gainers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

跌幅榜

interval 时间窗内跌幅最大的币种(默认 24h,或 7d)。行数据结构与分页信封同 List coins

GET
http://localhost/api/v1/coins/losers
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/losers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取币种详情

完整的单币种资料。在列表字段之外,还增加了:supply(流通量/总量/最大供应量)、today OHLC、all_time_high / all_time_low(价格、日期以及相对当前价格的 percent_from)、fully_diluted_valuation、市场 counts(交易所/交易对/行情/钱包)、decimalsgenesis_date、官方 links(带类型的 url 列表)、代币 contracts,以及本地化的 HTML description(当所请求的语言缺失时回退至英语)。所有价格/供应量字段均为十进制字符串。

GET
http://localhost/api/v1/coins/{slug}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

locale
string 可选
en

描述的内容语言(回退至英语)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

K 线历史

按币种的 OHLC + 交易量 + 市值时间序列。可选择 interval:minutely、half-hourly、hourly 或 daily。数据保留时长是汇总管道的硬性属性——minutely 保留 8 天,half-hourly 保留 3 个月,hourly 保留 6 个月,daily 永久保留;超出窗口的请求只返回现有数据。设置 limit 时,你将获得该窗口内最近的 N 行,并按由旧到新的顺序输出。价格为十进制字符串。

GET
http://localhost/api/v1/coins/{slug}/history
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

interval
string 可选
daily

minutely、half-hourly、hourly 或 daily(默认 daily)。

start
string 可选
2026-06-01

ISO 日期/时间下限。

end
string 可选
2026-06-30

ISO 日期/时间上限(仅含日期的值表示截至当天为止)。

limit
integer 可选
30

最大行数(1–2000,默认 1000)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

市值历史

Candle history 相同的按币种汇总数据,但仅投影为 {time, marketcap}interval 选项与保留窗口相同(minutely 8 天,half-hourly 3 个月,hourly 6 个月,daily 永久),设置 limit 时返回最近的 N 条。

GET
http://localhost/api/v1/coins/{slug}/marketcap-history
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

interval
string 可选
daily

minutely、half-hourly、hourly 或 daily(默认 daily)。

start
string 可选
2026-06-01

ISO 日期/时间下限。

end
string 可选
2026-06-30

ISO 日期/时间上限。

limit
integer 可选
30

最大行数(1–2000,默认 1000)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/marketcap-history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

币种走势图

该币种在所选 period 内的紧凑价格序列,用于绘制走势图。

GET
http://localhost/api/v1/coins/{slug}/sparkline
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

period
string 可选
7d

24h、7d、30d、60d、90d、180d 或 365d(默认 7d)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 个端点

价格

轻量级价格热路径——为所请求的一组币种返回当前价格、市值、24 小时交易量与近期涨跌幅。/prices 需要一个选择器(ids、slugs 或 symbols);/prices/{slug} 则针对单个币种。可选择 convert 为某种法币(加密货币价格约每分钟刷新,法币汇率约每日两次)。价格与市值为十进制字符串。

获取价格

所请求的一组币种的价格。至少传入一个选择器——idsslugssymbols(合计最多 100 个)。meta.currency 会回显转换目标(除非设置了 convert,否则为 USD)。

GET
http://localhost/api/v1/prices
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

ids
string 可选
38,39

要计价的币种 id(CSV)。ids、slugs 或 symbols 中至少需提供一个;三个列表合计上限为 100 个选择器。当 slugssymbols 均未提供时,此字段为必填。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

要计价的币种 slug(CSV)。ids、slugs 或 symbols 中至少需提供一个。当 idssymbols 均未提供时,此字段为必填。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

要计价的币种 symbol(CSV,不区分大小写)。ids、slugs 或 symbols 中至少需提供一个。当 idsslugs 均未提供时,此字段为必填。长度不得超过 1000 个字符。

convert
string 可选
EUR

按符号将价格/市值转换为某种有效法币(默认 USD)。汇率约每日刷新两次。

取值之一: USD EUR JPY BGN CZK DKK GBP HUF PLN RON SEK CHF ISK NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR ILS INR KRW MXN MYR NZD PHP SGD THB ZAR ARS DZD MAD TWD

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/prices?ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取币种价格

单币种价格快照。可选择按符号 convert 为某种有效法币(默认 USD)。

GET
http://localhost/api/v1/prices/{slug}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

convert
string 可选
EUR

用于计价的有效法币符号(默认 USD)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/prices/bitcoin?convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

历史价格

某币种在指定日期的 USD 价格,读取自每日历史(精确到当天,±3 天回退——与投资组合所用的解析器相同)。仅限加密货币:法币行没有每日历史。

GET
http://localhost/api/v1/historical-price
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

date
string 必填
2021-04-14

date 查询日期(在 2008-12-31 之后,且不得为将来)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/historical-price?slug=bitcoin&date=2021-04-14" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 个端点

市场

行情(按交易所划分的市场)与交易对(跨场所聚合的市场),以及某个币种的市场和按交易所划分的原始交易代码。所有这些都是快照数据——不存在按行情/交易对的历史。USD 交易量为数字;价格为十进制字符串。

币种市场

某个币种的全部市场——即交易对中以该币种为基础币或计价币的行情。行数据结构与筛选条件同 List tickers

GET
http://localhost/api/v1/coins/{slug}/markets
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

exchange
string 可选
binance-exchange

按 slug 限定为单个交易所(在已按交易所划分作用域的列表上请省略)。必须匹配正则 /^[a-z0-9-]{1,120}$/。

pair
integer 可选
1

按 id 限定为单个交易对。必须至少为 1。

instrument
string 可选
spot

合约品种类型:future、option、swap、spot 或 margin(可接受复数形式)。

取值之一: future option swap spot margin

search
string 可选
BTC

对行情代码的自由文本匹配。长度不得超过 50 个字符。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的行情。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的行情。必须至少为 0。

min_change
number 可选
-50

仅返回 24 小时百分比涨跌幅不低于此值的行情。

max_change
number 可选
50

仅返回 24 小时百分比涨跌幅不高于此值的行情。

sort
string 可选
-volume_usd

单个排序字段(前缀 - 表示降序)。可排序字段:volume_usd、change_24h、price_usd、updated。默认为 -volume_usd。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/markets?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

币种交易代码

该币种按交易所划分的原始交易代码——稀疏填充的参考数据(覆盖范围为尽力而为)。

GET
http://localhost/api/v1/coins/{slug}/symbols
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/symbols" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

行情列表

按交易所划分的单个市场(行情),分页返回。可按交易所、交易对、合约品种以及交易量/涨跌幅区间筛选。USD 交易量为数字;价格为十进制字符串。

GET
http://localhost/api/v1/tickers
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

exchange
string 可选
binance-exchange

按 slug 限定为单个交易所(在已按交易所划分作用域的列表上请省略)。必须匹配正则 /^[a-z0-9-]{1,120}$/。

pair
integer 可选
1

按 id 限定为单个交易对。必须至少为 1。

instrument
string 可选
spot

合约品种类型:future、option、swap、spot 或 margin(可接受复数形式)。

取值之一: future option swap spot margin

search
string 可选
BTC

对行情代码的自由文本匹配。长度不得超过 50 个字符。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的行情。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的行情。必须至少为 0。

min_change
number 可选
-50

仅返回 24 小时百分比涨跌幅不低于此值的行情。

max_change
number 可选
50

仅返回 24 小时百分比涨跌幅不高于此值的行情。

sort
string 可选
-volume_usd

单个排序字段(前缀 - 表示降序)。可排序字段:volume_usd、change_24h、price_usd、updated。默认为 -volume_usd。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

交易对列表

跨场所聚合的交易对,按 24 小时 USD 交易量排名。可按币种 slug(基础币或计价币)与交易量区间筛选。

GET
http://localhost/api/v1/pairs
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

search
string 可选
BTC

对交易对代码的自由文本匹配。长度不得超过 50 个字符。

coin
string 可选
bitcoin

限定为以该币种 slug 作为基础币或计价币的交易对。必须匹配正则 /^[a-z0-9-]{1,120}$/。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的交易对。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的交易对。必须至少为 0。

sort
string 可选
-volume_usd

排序字段:volume_usd 或 updated(前缀 - 表示降序)。默认为 -volume_usd。

取值之一: volume_usd -volume_usd updated -updated

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/pairs?page=1&per_page=50&search=BTC&coin=bitcoin&min_volume=1000000&max_volume=100000000000&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取交易对详情

一个交易对,以及上架该交易对的所有交易所行情,按交易量排序。

GET
http://localhost/api/v1/pairs/{id}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
1

交易对 id。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/pairs/1" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
7 个端点

交易所

交易所排名、详情、信任评分、时间序列,以及按交易所划分的市场/币种列表。交易量以 USD 计。没有单独的 CEX/DEX 字段——type 由交易所分类体系推导得出,因此可能为 "cex"、"dex" 或 null。

交易所列表

带 24 小时交易量、市场份额、交易对/资产数量及近期变化的排名交易所。采用 Laravel 的 links + meta 信封分页。

GET
http://localhost/api/v1/exchanges
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
cex

限定为某种场所类型:cex 或 dex(通过交易所分类体系解析)。

取值之一: cex dex

search
string 可选
binance

对交易所名称的自由文本匹配。长度不得超过 100 个字符。

min_pairs
integer 可选
100

仅返回上架交易对数量不少于此值的交易所。必须至少为 0。

max_pairs
integer 可选
2000

仅返回上架交易对数量不超过此值的交易所。必须至少为 0。

min_assets
integer 可选
50

仅返回上架资产数量不少于此值的交易所。必须至少为 0。

max_assets
integer 可选
1000

仅返回上架资产数量不超过此值的交易所。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的交易所。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的交易所。必须至少为 0。

ids
string 可选
1,12

筛选特定的交易所 id(CSV,最多 100 个)。长度不得超过 1000 个字符。

slugs
string 可选
binance-exchange,gateio

筛选特定的交易所 slug(CSV,最多 100 个)。长度不得超过 2000 个字符。

sort
string 可选
-volume

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:volume、rank、volume_dominance、change_24h、change_7d、pairs、assets。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges?page=1&per_page=50&type=cex&search=binance&min_pairs=100&max_pairs=2000&min_assets=50&max_assets=1000&min_volume=1000000&max_volume=100000000000&ids=1%2C12&slugs=binance-exchange%2Cgateio&sort=-volume" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取交易所详情

完整的单个交易所资料:排名、交易量/市场份额、交易对与资产数量、established 日期、location、推荐 website,以及推导出的 type(cex/dex/null)。

GET
http://localhost/api/v1/exchanges/{slug}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取交易所信任评分

一个 0–10 的综合信任 score,以及其 13 项因子 breakdown(rank、volume、age、volume_trend、stability、rank_stability、ticker_health、pairs、community、assets、dominance、market_breadth、transparency)。按交易所计算并缓存 24 小时。

GET
http://localhost/api/v1/exchanges/{slug}/trust-score
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/trust-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

交易所历史

交易量 / 市场份额 / 交易对 / 资产的时间序列(交易所汇总不含 OHLC)。可选择 interval:minutely、hourly 或 daily。数据保留时长是汇总管道的硬性属性——minutely 保留 8 天,hourly 保留 6 个月,daily 永久保留;设置 limit 时,你将获得该窗口内最近的 N 行,并按由旧到新的顺序返回。

GET
http://localhost/api/v1/exchanges/{slug}/history
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

查询参数

interval
string 可选
daily

minutely、hourly 或 daily(默认 daily)。

start
string 可选
2026-06-01

ISO 日期/时间下限。

end
string 可选
2026-06-30

ISO 日期/时间上限(仅含日期的值表示截至当天为止)。

limit
integer 可选
30

最大行数(1–2000,默认 1000)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

交易所走势图

该交易所在某个周期内的交易量走势图序列(默认 7d)——与网页交易所行所渲染的序列相同。

GET
http://localhost/api/v1/exchanges/{slug}/sparkline
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

查询参数

period
string 可选
7d

24h7d(默认)、30d60d90d180d365d 之一。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

交易所市场

该交易所的行情列表(即其市场),分页返回。已按该交易所划定作用域——此处请勿传入 exchange 参数。

GET
http://localhost/api/v1/exchanges/{slug}/tickers
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

exchange
string 可选
binance-exchange

按 slug 限定为单个交易所(在已按交易所划分作用域的列表上请省略)。必须匹配正则 /^[a-z0-9-]{1,120}$/。

pair
integer 可选
1

按 id 限定为单个交易对。必须至少为 1。

instrument
string 可选
spot

合约品种类型:future、option、swap、spot 或 margin(可接受复数形式)。

取值之一: future option swap spot margin

search
string 可选
BTC

对行情代码的自由文本匹配。长度不得超过 50 个字符。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的行情。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的行情。必须至少为 0。

min_change
number 可选
-50

仅返回 24 小时百分比涨跌幅不低于此值的行情。

max_change
number 可选
50

仅返回 24 小时百分比涨跌幅不高于此值的行情。

sort
string 可选
-volume_usd

单个排序字段(前缀 - 表示降序)。可排序字段:volume_usd、change_24h、price_usd、updated。默认为 -volume_usd。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

交易所币种

该交易所上架的币种,返回结构与 List coins 相同,并接受相同的筛选/排序。

GET
http://localhost/api/v1/exchanges/{slug}/assets
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
binance-exchange

交易所 slug。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 个端点

钱包

加密钱包评测——评测 score、支持资产数量、优点/缺点数量、价格模式与发布日期,并在详情/对比响应中附带分组的标签分类体系。meta.top_score 为所有钱包中的最高分(可用它将分数归一化到 0–1 区间)。

钱包列表

带评分、资产数量、优点/缺点数量、价格模式、状态与发布日期的已评测钱包。采用 Laravel 的 links + meta 信封分页,并附带 meta.top_score

GET
http://localhost/api/v1/wallets
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

search
string 可选
ledger

对钱包名称的自由文本匹配。长度不得超过 100 个字符。

min_score
integer 可选
50

仅返回评测分数不低于此值的钱包。必须至少为 0。

max_score
integer 可选
214

仅返回评测分数不高于此值的钱包。必须至少为 0。

tags
string 可选
12,34

按标签分类体系筛选:以逗号分隔的分类组 id(与网页分面筛选提交的 id 相同)。长度不得超过 1000 个字符。

ids
string 可选
175,317

筛选特定的钱包 id(CSV,最多 100 个)。长度不得超过 1000 个字符。

slugs
string 可选
frostsnap,coin98-fusion-card

筛选特定的钱包 slug(CSV,最多 100 个)。长度不得超过 2000 个字符。

sort
string 可选
-score

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:score、released_at、assets、pros、cons。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/wallets?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

钱包发布时间线

released_at 降序固定排列的钱包列表(无日期的钱包排在最后)。行数据结构与分页信封同 List wallets

GET
http://localhost/api/v1/wallets/timeline
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

search
string 可选
ledger

对钱包名称的自由文本匹配。长度不得超过 100 个字符。

min_score
integer 可选
50

仅返回评测分数不低于此值的钱包。必须至少为 0。

max_score
integer 可选
214

仅返回评测分数不高于此值的钱包。必须至少为 0。

tags
string 可选
12,34

按标签分类体系筛选:以逗号分隔的分类组 id(与网页分面筛选提交的 id 相同)。长度不得超过 1000 个字符。

ids
string 可选
175,317

筛选特定的钱包 id(CSV,最多 100 个)。长度不得超过 1000 个字符。

slugs
string 可选
frostsnap,coin98-fusion-card

筛选特定的钱包 slug(CSV,最多 100 个)。长度不得超过 2000 个字符。

sort
string 可选
-score

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:score、released_at、assets、pros、cons。长度不得超过 100 个字符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/wallets/timeline?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

对比钱包

2–4 个钱包的并排对比,附带其完整的分组标签分类体系。data[] 会保留所请求的 slug 顺序,便于调用方按位置渲染各列。

GET
http://localhost/api/v1/wallets/compare
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

slugs
string 必填
frostsnap,coin98-fusion-card

2–4 个不同的钱包 slug,以逗号分隔。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/wallets/compare?slugs=frostsnap%2Ccoin98-fusion-card" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取钱包详情

完整的单个钱包资料,包含分组的标签分类体系:categories 是一个 {group, tags[]} 列表,其中每个标签都带有 slug、name 及可选的 value。meta.top_score 为所有钱包中的最高分。

GET
http://localhost/api/v1/wallets/{slug}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
frostsnap

钱包 slug。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

钱包支持的币种

该钱包支持的币种,返回结构与 List coins 相同,并接受相同的筛选/排序。

GET
http://localhost/api/v1/wallets/{slug}/assets
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
frostsnap

钱包 slug。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

type
string 可选
coin

限定为单一资产类型:coin 或 token。

取值之一: coin token

status
string 可选
active

上架状态:active、delisted、untracked、progressing、awaiting 或 preparing。默认为所有公开状态。

取值之一: active delisted untracked progressing awaiting preparing

search
string 可选
bitcoin

对名称或代码的自由文本匹配。长度不得超过 100 个字符。

min_price
number 可选
0.5

仅返回价格不低于此 USD 值的币种。必须至少为 0。

max_price
number 可选
100000

仅返回价格不高于此 USD 值的币种。必须至少为 0。

min_marketcap
number 可选
1000000

仅返回 USD 市值不低于此值的币种。必须至少为 0。

max_marketcap
number 可选
5000000000000

仅返回 USD 市值不高于此值的币种。必须至少为 0。

min_volume
number 可选
1000000

仅返回 24 小时 USD 交易量不低于此值的币种。必须至少为 0。

max_volume
number 可选
100000000000

仅返回 24 小时 USD 交易量不高于此值的币种。必须至少为 0。

ids
string 可选
38,39

筛选特定的币种 id(CSV,与 slugs/symbols 合计最多 100 个选择器)。长度不得超过 1000 个字符。

slugs
string 可选
bitcoin,ethereum

筛选特定的币种 slug(CSV,合计最多 100 个选择器)。长度不得超过 2000 个字符。

symbols
string 可选
BTC,ETH

筛选特定的币种 symbol(CSV,不区分大小写,合计最多 100 个选择器)。长度不得超过 1000 个字符。

sort
string 可选
-marketcap

以逗号分隔的排序字段;前缀 - 表示降序。可排序字段:marketcap、rank、price、volume_24h、change_24h、change_7d。长度不得超过 100 个字符。

interval
string 可选
24h

仅用于 /coins/gainers 与 /coins/losers 的涨跌时间窗:24h 或 7d。

取值之一: 24h 7d

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 个端点

全球市场

覆盖全市场的聚合数据——总市值与交易量,资产/交易所/交易对/市场数量,BTC/ETH 市场份额及基于排名的前三名,市场恐惧与贪婪读数,以及前 100 名热力图和市值/交易量历史。

全球市场快照

一次性市场概览:总市值与 24 小时交易量,加密货币 / 代币 / 交易所 / 交易对 / 市场的数量,dominance(BTC 与 ETH 的占比以及基于排名的 top3),以及市场 fear_greed 读数。

GET
http://localhost/api/v1/global
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/global" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

市场热力图

前 100 名的树状图行以及概览统计(总市值/交易量、市场份额与市场恐惧与贪婪分数)——网页热力图的 API 对应版本。

GET
http://localhost/api/v1/global/heatmap
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/global/heatmap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

全球市值 / 交易量历史

marketcapvolume 的全市场时间序列。粒度取决于 period:24h = 每半小时,7d = 每小时,30d/all = 每日(更细的汇总会被清除)。

GET
http://localhost/api/v1/global/history/{metric}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

metric
string 必填
marketcap

选择哪个序列:marketcap 或 volume。

查询参数

period
string 可选
7d

24h、7d、30d 或 all(默认 24h)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/global/history/marketcap?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 个端点

市场情绪

市场及单币种情绪指数。恐惧与贪婪指数及牛熊指数均为每 15 分钟刷新的快照——仅存在当前读数,没有时间序列。山寨季则带有完整的每日历史。indicators 为覆盖全市场的技术指标统计。

社区投票统计

该币种在滚动 24 小时窗口内的看涨/看跌社区投票统计。

GET
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

投出情绪投票

为某个币种投出密钥所有者的情绪投票。在每个滚动的 24 小时窗口内,每位密钥所有者对每个币种仅可投一票——在窗口内再次投票将更新既有投票。

POST
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

请求体参数

vote
string 必填
bullish

你的情绪倾向:bullishbearish

请求

curl --request POST \
    "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vote\": \"bullish\"
}"

恐惧与贪婪指数

当前的恐惧与贪婪读数(15 分钟快照——无历史)。省略 coin 可获取全市场指数,或传入币种 slug 以获取单币种读数。intervals 携带 7d/30d 的子分数及其组成明细。

GET
http://localhost/api/v1/sentiment/fear-greed
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

coin
string 可选
bitcoin

用于获取单个币种读数的币种 slug;若需市场指数则省略。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/sentiment/fear-greed?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

牛熊指数

当前的牛熊读数(15 分钟快照——无历史)。省略 coin 可获取全市场指数,或传入币种 slug 以获取单币种读数。

GET
http://localhost/api/v1/sentiment/bull-bear
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

coin
string 可选
bitcoin

用于获取单个币种读数的币种 slug;若需市场指数则省略。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/sentiment/bull-bear?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

山寨季指数

当前的山寨季读数(前 100 名中跑赢 BTC 的币种数量),可选带每日 history。与恐惧与贪婪不同,山寨季拥有完整的每日历史——传入 days 即可包含它。

GET
http://localhost/api/v1/sentiment/altseason
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

days
integer 可选
30

要包含的每日历史天数(1–365;0/省略 = 仅当前)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/sentiment/altseason?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

市场指标统计

覆盖全市场的技术指标统计——汇总了 25 个指标类别,每个类别都带有其当前状态、分数及类别数据。

GET
http://localhost/api/v1/sentiment/indicators
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/sentiment/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
2 个端点

指标

按币种的技术指标——一份多指标快照以及各指标族的每日时间序列。所有指标族均为基于日线 K 线计算的每日序列(完整保留;新上线的资产在积累足够历史之前会返回预热的 null)。价格量级的指标族(sma、vwap、macd、obv)输出十进制字符串;有界震荡指标则输出数字。部分长窗口周期需要付费套餐(参见指标族端点)。

指标快照

多指标快照——在一个载荷中呈现每个指标类别最新的 state(看涨/看跌/观望……)、score 与原始 data

GET
http://localhost/api/v1/coins/{slug}/indicators
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

指标族序列

某个指标族的每日时间序列。具有多个窗口的指标族接受 period,且各指标族的有效窗口各不相同:RSI/Stoch-RSI 为 7/14/21/28,SMA 为 50/100/200,CCI 为 20/50/100,MFI 为 7/14/28,Williams %R 为 14/20/50,price/volume-volatility 为 7/14/30。单序列指标族(MACD、OBV、ADX、VWAP、CMF)会忽略 period。新上线的币种会在开头返回预热的 null

部分长窗口需要付费套餐:RSI 与 Stoch-RSI 的 21/28 日窗口以及 30 日波动率窗口需要 Starter 或更高套餐——在 Free 套餐上请求这些窗口将返回 403,错误码为 plan_required

GET
http://localhost/api/v1/coins/{slug}/indicators/{family}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

币种 slug。

family
string 必填
rsi

指标族——rsi、stoch-rsi、sma、cci、mfi、williams-r、price-volatility、volume-volatility、macd、obv、adx、vwap、cmf 之一。

查询参数

period
integer 可选
14

窗口长度(仅在该指标族存在窗口时适用;必须为该指标族有效窗口之一)。

start
string 可选
2026-06-01

ISO 日期下限。

end
string 可选
2026-06-30

ISO 日期上限。

limit
integer 可选
30

最大行数(1–1000,默认 365)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators/rsi?period=14&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 个端点

清算

衍生品清算。当前数据来源仅覆盖 OKX 永续合约市场(在每个 meta.note 中均有说明)。原始数据流(/liquidations 列表与按小时的明细)在约 48 小时后会被清除;按日汇总数据则永久保留。当日的聚合数据为部分数据,约每 15 分钟更新一次。

清算数据流

原始清算数据流(约最近 48 小时,之后被清除),按最新优先。当前数据来源覆盖 OKX 永续合约市场。价格为十进制字符串。meta 携带分页字段以及 retentionnote

GET
http://localhost/api/v1/liquidations
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。必须至少为 1。

per_page
integer 可选
50

每页行数。上限取决于套餐(Free 100,Starter/Pro 250);超出上限将返回 422,而不会自动截断。必须至少为 1。不得大于 100。

exchange
string 可选
okx

按 slug 限定为单个交易所。当前数据来源覆盖 OKX 永续合约市场。必须匹配正则 /^[a-z0-9-]{1,120}$/。

instrument
string 可选
swap

合约品种类型:future、option、swap、spot 或 margin。

取值之一: future option swap spot margin

position
string 可选
short

被清算的持仓方向:long 或 short。

取值之一: long short

order
string 可选
buy

触发清算的成交方向:buy 或 sell。

取值之一: buy sell

symbol
string 可选
BTC

按场所 instId 前缀匹配(例如 BTC 匹配 BTC-USDT-SWAP)。必须匹配正则 /^[A-Za-z0-9$.-]{1,25}$/。

min_usd
number 可选
1000

仅返回 USD 金额不低于此阈值的清算。必须至少为 0。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations?page=1&per_page=50&exchange=okx&instrument=swap&position=short&order=buy&symbol=BTC&min_usd=1000" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

每小时清算

基于原始数据流的每小时多头/空头 USD 总额。由于原始数据流约在 48 小时后被清除,hours 上限为 48。当前数据来源覆盖 OKX 永续合约市场。

GET
http://localhost/api/v1/liquidations/hourly
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

hours
integer 可选
24

回溯时间窗,单位为小时(1–48,默认 24)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations/hourly?hours=24" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

每日清算

按日聚合数据(永久保留),按天跨交易所/合约品种汇总——总计/多头/空头 USD 以及多头/空头持仓数量。当日的行为部分数据,约每 15 分钟更新一次。当前数据来源覆盖 OKX 永续合约市场。

GET
http://localhost/api/v1/liquidations/daily
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

days
integer 可选
30

包含今天在内的日历天数(1–365,默认 30)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations/daily?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

今日清算汇总

今日截至目前——总计/多头/空头 USD、持仓数量以及多空 dominance。数据为部分数据,约每 15 分钟更新一次;在当日首笔清算被记录之前,data 为 null。当前数据来源覆盖 OKX 永续合约市场。

GET
http://localhost/api/v1/liquidations/summary
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations/summary" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

清算净流量

在时间窗内每日的多头与空头清算 USD 流量。当前数据来源覆盖 OKX 永续合约市场。

GET
http://localhost/api/v1/liquidations/netflow
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

days
integer 可选
30

包含今天在内的日历天数(1–90,默认 30)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations/netflow?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

清算量最高的币种

近期窗口内按清算量排名靠前的币种,附带每个币种的多头/空头 USD 分布。当前数据来源覆盖 OKX 永续合约市场。

GET
http://localhost/api/v1/liquidations/coins
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

hours
integer 可选
24

回溯时间窗,单位为小时(1–48,默认 24)。

limit
integer 可选
8

返回的币种数量(1–20,默认 8)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/liquidations/coins?hours=24&limit=8" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 个端点

转换

在任意两种有效资产之间进行转换(加密货币与法币皆可),并列出可用作转换币种的货币。数值为十进制字符串。法币汇率约每日刷新两次;加密货币汇率约每分钟刷新。

资产间转换

在任意两种有效资产之间进行服务端转换(加密货币与法币皆可)。to 接受 CSV 以实现多目标转换;反向转换只需交换 from/to。转换是线性的,因此 value = unit_rate * amount。法币汇率约每日刷新两次;加密货币汇率约每分钟刷新。

GET
http://localhost/api/v1/convert
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

from
string 必填
bitcoin

源资产 slug。

to
string 必填
ethereum

目标资产 slug,以逗号分隔(最多 10 个)。

amount
number 可选
2.5

要转换的源资产数量(默认 1)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/convert?from=bitcoin&to=ethereum&amount=2.5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

法币列表

有效法币及其对 USD 的汇率:rate_per_usd(每 USD 的单位数)及其倒数 usd_value。法币汇率约每日刷新两次。

GET
http://localhost/api/v1/fiats
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/fiats" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

转换汇率列表

可用作转换币种的对比货币——热门法币、币种与代币——每个都带有归一化的 usd_value(每单位对应的 USD)。币种/代币的数值约每分钟刷新;较慢的法币汇率则单独缓存(约每日两次)。

GET
http://localhost/api/v1/rates
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/rates" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 个端点

计算器

与网页工具对应的服务端金融计算器:DCA、盈亏与借贷(这些会读取缓存的市场数据),以及无状态的复利与质押计算。

DCA 计算器

基于该币种真实每日价格历史的定投(DCA)回测:在 startend 之间,每个 interval 买入 amount。传入 series=true 可包含完整的逐笔买入序列。

GET
http://localhost/api/v1/calculators/dca
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

amount
number 必填
100

每次买入花费的 USD 金额(0.01–1,000,000,000)。

interval
string 必填
weekly

买入频率:dailyweeklymonthlyquarterlyyearly

start
string 必填
2024-01-01

date 首次买入日期(须在 2008-12-31 之后)。

end
string 可选
2025-01-01

date 最后一次买入日期(默认为今天)。

series
boolean 可选
false

在载荷中包含逐笔买入序列。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/calculators/dca?slug=bitcoin&amount=100&interval=weekly&start=2024-01-01&end=2025-01-01&series=" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

盈亏计算器

在两个历史日期之间先买入后卖出所得到的结果,使用该币种在这两个日期的真实价格。手续费为固定 USD 金额,而非百分比。

GET
http://localhost/api/v1/calculators/profit-loss
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

amount
number 必填
1000

buy_date 投入的 USD 金额(0.01–1,000,000,000)。

buy_date
string 必填
2023-01-01

date 买入日期。

sell_date
string 必填
2025-01-01

date 卖出日期(等于或晚于 buy_date)。

buy_fee
number 可选
10

固定买入手续费,单位为 USD(默认 0)。

sell_fee
number 可选
10

固定卖出手续费,单位为 USD(默认 0)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/calculators/profit-loss?slug=bitcoin&amount=1000&buy_date=2023-01-01&sell_date=2025-01-01&buy_fee=10&sell_fee=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

复利计算器

纯数学计算——不涉及市场数据。请注意,利率按每个复利周期计(沿用网页计算器的惯例),而非按年计。

GET
http://localhost/api/v1/calculators/compound-interest
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

principal
number 必填
10000

初始余额,单位为 USD。

rate
number 必填
1

每个复利周期的利率,单位为 %。

duration
integer 必填
5

推算的时间长度(年数上限为 50)。

duration_unit
string 可选
years

years(默认)或 months

compound_frequency
string 可选
monthly

dailyweeklymonthly(默认)、quarterlyannually

contribution
number 可选
100

定期存入金额,单位为 USD(默认 0)。

contribution_frequency
string 可选
monthly

dailyweeklymonthly(默认)、quarterlyannually

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/calculators/compound-interest?principal=10000&rate=1&duration=5&duration_unit=years&compound_frequency=monthly&contribution=100&contribution_frequency=monthly" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

借贷与卖出对比计算器

抵押加密货币借贷与直接卖出的对比——使用该币种的当前价格比较两种方案。仅为参考性推算,不构成财务建议。

GET
http://localhost/api/v1/calculators/loan
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

crypto_amount
number 必填
2

你持有的该币种数量。

needed_cash
number 必填
50000

你需要腾出的 USD 金额。

term_months
integer 可选
36

贷款期限,单位为月(默认 36)。

interest_rate
number 可选
10

贷款年利率(APR),单位为 %(默认 10)。

ltv
number 可选
50

贷款价值比(LTV),单位为 %(默认 50)。

expected_growth
number 可选
25

预期该币种在期限内的价格涨幅,单位为 %(默认 25)。

tax_rate
number 可选
25

对卖出所适用的资本利得税,单位为 %(默认 25)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/calculators/loan?slug=bitcoin&crypto_amount=2&needed_cash=50000&term_months=36&interest_rate=10&ltv=50&expected_growth=25&tax_rate=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

质押收益计算器

纯数学计算——质押收益,可选复利及验证者佣金。不读取任何市场数据。

GET
http://localhost/api/v1/calculators/staking
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

amount
number 必填
1000

质押数量,以所质押资产的单位计。

period
number 必填
2

质押周期的长度(上限为等效于 50 年)。

period_unit
string 可选
years

years(默认)、monthsdays

apy
number 必填
5

标示的年化收益率(APY),单位为 %。

compound_frequency
string 可选
monthly

neverdailyweeklymonthly(默认)或 yearly

commission
number 可选
10

验证者佣金,单位为 %,从收益中扣除(默认 0)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/calculators/staking?amount=1000&period=2&period_unit=years&apy=5&compound_frequency=monthly&commission=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
8 个端点

编辑内容

编辑文章——仅限已发布(ACTIVE)的文章。locale 决定内容语言,并按字段回退至英语(返回内容会说明实际采用了哪个 locale)。文章可按标签或关联的币种/交易所/钱包 slug 筛选。API 读取有意不会增加浏览次数。

币种视频

关联到某个币种的精选视频(币种页面的「视频」标签页),分页返回。

GET
http://localhost/api/v1/coins/{slug}/videos
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

查询参数

page
integer 可选
1

页码(从 1 开始)。

per_page
integer 可选
10

每页行数(1–50,默认 10)。

type
string 可选
review

按视频类型筛选(例如 overviewtutorialexplainerreviewanalysisnews)。

search
string 可选
halving

对标题的自由文本匹配。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/videos?page=1&per_page=10&type=review&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

币种洞察时间线

该币种的洞察时间线——与资产页面洞察面板所用的载荷相同,通过 offset/limit 划定窗口。

GET
http://localhost/api/v1/coins/{slug}/insights
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
bitcoin

该币种的 slug 标识符。

查询参数

locale
string 可选
en

内容语言(回退至英语)。

offset
integer 可选
0

要跳过的行数(0–500,默认 0)。

limit
integer 可选
5

返回的行数(1–50,默认 5)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/insights?locale=en&offset=0&limit=5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

文章列表

已发布的文章,按最新优先,分页返回。可按 tag,或按关联的 coin / exchange / wallet slug,或自由文本 search 筛选。每行为一条摘要(标题、副标题、标签、阅读时长、主图、相关实体、日期)。

GET
http://localhost/api/v1/articles
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。

per_page
integer 可选
20

每页行数(1–50,默认 20)。

locale
string 可选
en

内容语言(回退至英语)。

tag
string 可选
guide

按标签筛选:news、guide、tutorial、explainer、analysis、review、trading、overview 或 information。

coin
string 可选
bitcoin

筛选与该币种 slug 相关的文章。

exchange
string 可选
binance-exchange

筛选与该交易所 slug 相关的文章。

wallet
string 可选
frostsnap

筛选与该钱包 slug 相关的文章。

search
string 可选
halving

对标题/副标题的自由文本匹配。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/articles?page=1&per_page=20&locale=en&tag=guide&coin=bitcoin&exchange=binance-exchange&wallet=frostsnap&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取文章

一篇已发布的文章,包含其完整正文、标签、主图、有用度计数以及相关实体。locale 决定内容语言,并按字段回退至英语(返回内容会说明实际采用了哪个语言)。

GET
http://localhost/api/v1/articles/{slug}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
what-is-bitcoin

文章的 slug。

查询参数

locale
string 可选
en

内容语言(回退至英语)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/articles/what-is-bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

提交文章反馈

为文章记录一次点赞/点踩——与网页「有用」按钮所使用的计数器相同。上游会应用按密钥的限流。

POST
http://localhost/api/v1/articles/{slug}/feedback
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

slug
string 必填
what-is-bitcoin

文章的 slug。

请求体参数

helpful
boolean 必填
true

true 表示有用,false 表示无用。

请求

curl --request POST \
    "http://localhost/api/v1/articles/what-is-bitcoin/feedback" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"helpful\": true
}"

获取视频

一个精选视频,包含其 YouTube id、标题、类型、时长,以及所关联的币种/交易所/钱包。

GET
http://localhost/api/v1/videos/{id}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
87

视频 id。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/videos/87" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

洞察列表

AI 生成的市场洞察,分页返回。可按 type、关联的 coin slug 或自由文本 search 筛选;locale 决定标题/摘要的语言,并以英语作为回退。

GET
http://localhost/api/v1/insights
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。

per_page
integer 可选
20

每页行数(1–50,默认 20)。

locale
string 可选
en

内容语言(回退至英语)。

type
string 可选
per_asset

按洞察类型筛选:per_assetmarket_overviewnarrative

coin
string 可选
bitcoin

筛选关于该币种 slug 的洞察。

search
string 可选
etf

对标题的自由文本匹配。

sort
string 可选
first_reported

排序方式:first_reported(默认)或 last_updated

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/insights?page=1&per_page=20&locale=en&type=per_asset&coin=bitcoin&search=etf&sort=first_reported" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

获取洞察

一条洞察及其完整载荷——标题、摘要、来源文章时间线以及相关币种。

GET
http://localhost/api/v1/insights/{id}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
101

洞察 id。

查询参数

locale
string 可选
en

内容语言(回退至英语)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/insights/101?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 个端点

警报

价格警报的增删改查——与网页应用管理的警报相同。警报会消耗密钥所有者的警报库存余额,仅可对币种设置 TARGET(目标价)类型,且有一个基于 above/below 与当前值的校验,用于阻止会立即自触发的警报。以密钥为作用域(API 密钥决定所有者),且从不缓存响应。

警报列表

密钥所有者的警报,按最新优先,分页返回。可按 statusdirectionnotification 渠道筛选。

GET
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

查询参数

page
integer 可选
1

页码(从 1 开始)。

per_page
integer 可选
25

每页行数(1–100,默认 25)。

status
string 可选
active

按状态筛选:activetriggered

direction
string 可选
above

按触发方向筛选:abovebelow

notification
string 可选
email

按投递渠道筛选:emailpushwebhook

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/alarms?page=1&per_page=25&status=active&direction=above&notification=email" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

创建警报

为某个币种创建一个 TARGET(目标价)警报,并从密钥所有者的余额中消耗一个警报名额。目标值会与该币种的当前值进行校验,以确保警报不会立即自触发:above 警报的目标必须高于当前值,below 警报则必须低于当前值。

POST
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

请求体参数

name
string 必填
BTC six figures

警报的标签(最多 255 个字符)。

coin
string 必填
bitcoin

该币种的 slug 标识符。

metric
string 必填
rate

所监控的指标:ratevolumemarketcap

direction
string 必填
above

触发方向:abovebelow

target
number 必填
100000

阈值(必须位于该币种当前值的 direction 一侧)。

notification
string 必填
email

投递渠道:emailpushwebhook

请求

curl --request POST \
    "http://localhost/api/v1/alarms" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"BTC six figures\",
    \"coin\": \"bitcoin\",
    \"metric\": \"rate\",
    \"direction\": \"above\",
    \"target\": 100000,
    \"notification\": \"email\"
}"

删除警报

删除密钥所有者的一个警报,并退还其占用的警报名额。

DELETE
http://localhost/api/v1/alarms/{id}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
42

警报 id。

请求

curl --request DELETE \
    "http://localhost/api/v1/alarms/42" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 个端点

Webhooks

Bitculator 会将每个事件以 JSON 形式 POST,并附带一个 HMAC 签名请求头:

X-Bitculator-Signature: t=<unix-ts>,v1=<hex hmac_sha256("<ts>.<raw-body>", secret)>
X-Bitculator-Event: alarm.triggered

验证方法:用你的端点密钥对 "." 重新计算 HMAC,并以恒定时间进行比较;若 t 早于数分钟之前(防重放保护),则予以拒绝。示例(PHP):

[$t, $v1] = sscanf($_SERVER['HTTP_X_BITCULATOR_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
abort_unless(hash_equals($expected, $v1) && abs(time() - $t) < 300, 403);

支持的事件:alarm.triggered。投递失败会带退避重试 3 次;某个端点在连续 10 次投递失败后会自动停用。

Webhook 端点列表

密钥所有者的 Webhook 端点,按最新优先。签名密钥绝不会被包含——每个密钥仅在创建时展示一次。

GET
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

创建 Webhook 端点

注册一个用于事件投递的 HTTPS 端点(每个账户最多 5 个)。响应中包含用于签名的 secret——这是它唯一一次被展示,请立即妥善保存。

POST
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

请求体参数

url
string 必填
https://example.com/webhooks/bitculator

HTTPS 投递 URL。仅限公开主机——内部/私有地址将被拒绝。

events
string[] 必填
["alarm.triggered"]

要订阅的事件。允许的取值:alarm.triggered

请求

curl --request POST \
    "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/example.com\\/webhooks\\/bitculator\",
    \"events\": [
        \"alarm.triggered\"
    ]
}"

删除 Webhook 端点

删除密钥所有者的一个 Webhook 端点。发往该端点的待投递消息将被放弃。

DELETE
http://localhost/api/v1/webhooks/{id}
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
7

Webhook 端点 id。

请求

curl --request DELETE \
    "http://localhost/api/v1/webhooks/7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

发送测试事件

触发一个带签名的 alarm.triggered 测试事件(载荷中 test: true,签名请求头为真实值),以便对接收方进行端到端验证。

POST
http://localhost/api/v1/webhooks/{id}/test
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
7

Webhook 端点 id。

请求

curl --request POST \
    "http://localhost/api/v1/webhooks/7/test" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Webhook 投递日志

该端点的投递尝试记录(保留 30 天),按最新优先,分页返回。

GET
http://localhost/api/v1/webhooks/{id}/deliveries
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

路径参数

id
integer 必填
7

Webhook 端点 id。

查询参数

page
integer 可选
1

页码(从 1 开始)。

per_page
integer 可选
25

每页行数(1–100,默认 25)。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/webhooks/7/deliveries?page=1&per_page=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 个端点

Meta

API 元信息与自省:用于验证密钥及中间件栈的已认证 ping、当前密钥的用量/配额,以及机器可读的 OpenAPI 规范。

OpenAPI 规范

本 API 的机器可读 OpenAPI 3 文档,以 JSON 形式提供——将代码生成器或 API 工具指向此 URL 即可。公开:无需密钥。

GET
http://localhost/api/v1/openapi.json
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/openapi.json" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ping

一个已认证的空操作端点,用于端到端验证 Data API 密钥(auth.api → 按套餐的突发限流 → 每月配额)。它与其他任何调用一样会计入配额。

GET
http://localhost/api/v1/ping
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/ping" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

密钥用量与配额

针对调用密钥所有者的用量自省:Data API 套餐、每月上限、已用与剩余(始终与 X-Quota-* 响应头一致)、当前周期窗口,以及按端点 / 按令牌的明细。嵌入组件的用量有其独立的方案与配额池——绝不会出现在这里。

GET
http://localhost/api/v1/usage
Bearer
bc_••••••••••••••••

密钥仅支持 Bearer 方式并具备 data-api 权限——请将其保存在服务器端。

GET 请求——无请求体。

请求

curl --request GET \
    --get "http://localhost/api/v1/usage" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"