流式接收事件
GET/v1/stream
合同 v1 / 1.0.0 62 / 2026-10-10
本页内容
包含 event:payment、JSON 数据和心跳注释的 SSE,结构与 webhook v1 不同。通过 /events 补回遗漏事件;尚未实现 Last-Event-ID 重放。浏览器原生 EventSource 无法设置 Bearer 请求头:请使用服务器客户端或 fetch 流式读取,切勿把密钥放入查询参数。
密钥权限:stream / read。
请求示例
示例会在您的账户中执行真实操作。请设置代码指定的环境变量。保持密钥私密;写请求不会自动重试。
Shell / cURL
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
# A live SSE connection is deliberately limited to 30 seconds.
exec 3>&1
transfer_status=0
http_status="$(curl \
--silent --show-error --no-buffer --max-time 30 --request GET \
--header "Authorization: Bearer $CRYPTANIO_API_KEY" \
--header 'Accept: text/event-stream' \
"https://api.cryptanio.com/v1/stream" \
--output /dev/fd/3 --write-out '%{http_code}')" || transfer_status=$?
exec 3>&-
if [[ "$http_status" == 2?? ]]; then
exit "$transfer_status"
fi
printf 'HTTP %s\n' "$http_status" >&2
exit 1
Go
// Go; standard library only. Run: go run request.go
package main
import (
"fmt"
"io"
"net/http"
"net/url"
"os"
"time"
)
func env(name string) string {
value := os.Getenv(name)
if value == "" { fmt.Fprintln(os.Stderr, "Set", name); os.Exit(1) }
return value
}
func run() error {
path := "/v1/stream"
endpoint, err := url.Parse("https://api.cryptanio.com" + path)
if err != nil { return err }
query := endpoint.Query()
endpoint.RawQuery = query.Encode()
request, err := http.NewRequest("GET", endpoint.String(), nil)
if err != nil { return err }
request.Header.Set("Authorization", "Bearer " + env("CRYPTANIO_API_KEY"))
request.Header.Set("Accept", "text/event-stream")
client := &http.Client{Timeout: 30 * time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { return err }
defer response.Body.Close()
if response.StatusCode < 200 || response.StatusCode >= 300 {
body, err := io.ReadAll(response.Body)
if err != nil { return err }
return fmt.Errorf("HTTP %d: %s", response.StatusCode, body)
}
_, err = io.Copy(os.Stdout, response.Body)
return err
}
func main() {
if err := run(); err != nil { fmt.Fprintln(os.Stderr, err); os.Exit(1) }
}
Rust
// Cargo.toml dependencies:
// reqwest = { version = "=0.12.24", features = ["blocking", "json"] }
// serde_json = "=1.0.145"
use std::{error::Error, io, time::Duration};
use reqwest::{blocking::Client, redirect::Policy, Method, Url};
fn env(name: &str) -> Result<String, Box<dyn Error>> {
let value = std::env::var(name)?;
if value.is_empty() { return Err(format!("Set {name}").into()); }
Ok(value)
}
fn run() -> Result<(), Box<dyn Error>> {
let mut url = Url::parse("https://api.cryptanio.com")?;
{
let mut segments = url.path_segments_mut().map_err(|_| "Invalid base URL")?;
segments.clear();
segments.push("v1");
segments.push("stream");
}
let client = Client::builder().timeout(Duration::from_secs(30)).redirect(Policy::none()).build()?;
let request = client.request(Method::GET, url)
.header("Authorization", format!("Bearer {}", env("CRYPTANIO_API_KEY")?))
.header("Accept", "text/event-stream".to_owned());
let mut response = request.send()?;
let status = response.status();
if !status.is_success() { return Err(format!("HTTP {}: {}", status.as_u16(), response.text()?).into()); }
io::copy(&mut response, &mut io::stdout())?;
Ok(())
}
fn main() {
if let Err(error) = run() { eprintln!("{error}"); std::process::exit(1); }
}
PHP
<?php
// PHP 8 with the cURL extension. Run this on your server.
function env(string $name): string {
$value = getenv($name);
if ($value === false || $value === '') throw new RuntimeException('Set ' . $name);
return $value;
}
try {
$path = '/v1/stream';
$query = [
];
$url = 'https://api.cryptanio.com' . $path . ($query ? '?' . http_build_query($query, '', '&', PHP_QUERY_RFC3986) : '');
$headers = [
'Authorization: ' . 'Bearer ' . env('CRYPTANIO_API_KEY'),
'Accept: ' . 'text/event-stream',
];
$errorBody = '';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => false,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_WRITEFUNCTION => static function ($handle, string $chunk) use (&$errorBody): int {
$status = curl_getinfo($handle, CURLINFO_HTTP_CODE);
if ($status >= 200 && $status < 300) { fwrite(STDOUT, $chunk); }
else { $errorBody .= $chunk; }
return strlen($chunk);
},
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status < 200 || $status >= 300) throw new RuntimeException('HTTP ' . $status . ': ' . $errorBody);
} catch (Throwable $error) {
fwrite(STDERR, $error->getMessage() . PHP_EOL);
exit(1);
}
Python
# Python 3; standard library only.
import json
import os
import sys
from urllib.error import HTTPError, URLError
from urllib.parse import quote, urlencode
from urllib.request import HTTPRedirectHandler, Request, build_opener
def env(name):
result = os.environ.get(name)
if not result:
raise ValueError("Set " + name)
return result
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
try:
path = "/v1/stream"
query = {
}
url = "https://api.cryptanio.com" + path + ("?" + urlencode(query) if query else "")
headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "text/event-stream",
}
data = None
request = Request(url, data=data, headers=headers, method="GET")
with build_opener(NoRedirect()).open(request, timeout=30) as response:
if not 200 <= response.status < 300:
raise ValueError("HTTP " + str(response.status))
for line in response:
sys.stdout.buffer.write(line)
sys.stdout.buffer.flush()
except HTTPError as error:
print("HTTP " + str(error.code) + ": " + error.read().decode("utf-8", errors="replace"), file=sys.stderr)
sys.exit(1)
except (ValueError, URLError, OSError) as error:
print(str(error), file=sys.stderr)
sys.exit(1)
Node.js
// Node.js 18+. Run on your server, never in a browser.
const env = name => {
const result = process.env[name];
if (!result) throw new Error(`Set ${name}`);
return result;
};
try {
let path = "/v1/stream";
const url = new URL(path, "https://api.cryptanio.com");
const headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "text/event-stream",
};
const response = await fetch(url, {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
if (response.body) {
for await (const chunk of response.body) process.stdout.write(chunk);
}
} catch (error) {
console.error(error.message);
process.exitCode = 1;
}
响应与错误
200 Server-Sent Events 流。
text/event-stream
401 没有有效且已启用的 API 密钥(unauthorized)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
401 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 密钥不允许该操作、项目、服务或 IP;电子邮件未确认。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
403 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 请求过多(rate_limited);按 Retry-After 等待后重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
429 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 内部错误(internal)。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
500 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 暂时不可用(unavailable);请退避重试。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |
503 application/json
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}嵌套对象
StreamEvent
SSE data 中的 JSON;与 webhook v1 不同。非付款事件省略 payment,可能包含 contract。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
event_id | string | 是 | 不透明标识符;请保持为字符串。 minLength: 1 |
event_type | string | 是 | 事件类型;可能添加新类型。 |
chain | string | 是 | 网络代码。 |
service | string | 否 | 已知时的服务。 |
watch_id | string | 否 | 关联监控时的项目监控 ID。 minLength: 1 |
occurred_at | string | 是 | RFC 3339 格式的 UTC 日期和时间。date-time |
payment | object | null | 否 | 付款文档;非付款事件为 null。GET /events 不返回 contract/notice 载荷。 |
sandbox | boolean | 否 | 测试事件;省略时为 false。 |
project_id | string | 否 | 不透明标识符;请保持为字符串。 minLength: 1 |
project_name | string | 否 | 项目名称。 |
url | string | 否 | 指向 Account 事件的链接。uri |
contract | object | 否 | |
mode | string | 否 | live 或 test。live、test |
ID
不透明标识符。格式不保证固定;不要转换为数字。
string 不透明标识符。格式不保证固定;不要转换为数字。
EventPayment
REST/SSE 付款文档。字段取决于事件和网络;不是标准化的 webhook v1 结构。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
tx_id | string | 否 | 交易标识符。 |
index | integer | 否 | 交易内的转账索引。 minimum: 0 |
height | integer | 否 | 可确定时的区块高度。 minimum: 0 |
address | string | 否 | 被观察的地址。 |
asset | string | 否 | REST/SSE asset:字符串标识符,不是 webhook 中的 asset 对象。 |
amount_raw | string | 否 | 以字符串表示的最小单位整数金额。 pattern: ^[0-9]+$ |
amount | string | 否 | 精确十进制金额字符串;不要使用浮点数。 pattern: ^[0-9]+(?:\.[0-9]+)?$ |
decimals | integer | 否 | 小数位数。 minimum: 0 |
confirmations | integer | 否 | 确认数。 minimum: 0 |
revision | integer | 否 | 转账状态修订号。 minimum: 0 |
direction | string | 否 | 相对于被观察地址的方向。in、out |
simulated | boolean | 否 | 模拟事件。 |
late | boolean | 否 | 延迟检测到的转账。 |
block_hash | string | 否 | 区块哈希。 |
match_key | string | 否 | 网络使用时的匹配标识符。 |
meta | object | 否 | |
invoice | object | 否 | |
customer | object | 否 | |
product | object | 否 | |
payer | object | 否 | |
metadata | object | 否 |
RawAmount
string
Decimal
string
StringMap
object
Customer
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 您系统中的客户标识符。 maxLength: 120 |
Product
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 否 | 您系统中的产品标识符。 maxLength: 120 |
name | string | 否 | 产品名称。 maxLength: 200 |
quantity | integer | 否 | 数量。 minimum: 1; maximum: 1000000 |
Payer
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
comment | string | 是 | 付款人留言。 maxLength: 500 |
Error
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
error | object | 是 |