API reference

Stream events

GET/v1/stream

Contract v1 / 1.0.0 62 / 2026-10-10

On this page

SSE with event:payment, JSON data, and heartbeat comments. Its shape differs from webhook v1. Recover missing events through /events; Last-Event-ID replay is not implemented. Native browser EventSource cannot set Bearer headers: use a server client or fetch streaming, never a key in the query.

Key permissions: stream / read.

Request examples

Examples perform a real operation in your account. Set the environment variables named in the code. Keep your key private; write requests are not retried automatically.

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
Download example
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) }
}
Download example
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); }
}
Download example
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);
}
Download example
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)
Download example
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;
}
Download example

Responses and errors

200 Server-Sent Events stream.

text/event-stream

401 No valid active API key (unauthorized).
FieldTypeRequiredDescription
errorobjectYes
401 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
403 Key disallows the operation, project, service or IP; email unconfirmed.
FieldTypeRequiredDescription
errorobjectYes
403 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
429 Too many requests (rate_limited); retry after Retry-After.
FieldTypeRequiredDescription
errorobjectYes
429 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
500 Internal error (internal).
FieldTypeRequiredDescription
errorobjectYes
500 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}
503 Temporary unavailability (unavailable); retry with backoff.
FieldTypeRequiredDescription
errorobjectYes
503 application/json
{
  "error": {
    "code": "forbidden",
    "message": "this API key is read-only"
  }
}

Handling errors and retrying safely

Nested objects

StreamEvent

JSON in SSE data; differs from webhook v1. Non-payment events omit payment and may include contract.

FieldTypeRequiredDescription
event_idstringYesOpaque identifier; keep it as a string.
minLength: 1
event_typestringYesEvent type; new types may be added.
chainstringYesNetwork code.
servicestringNoService, when known.
watch_idstringNoProject watch ID, when linked to a watch.
minLength: 1
occurred_atstringYesUTC date and time in RFC 3339.
date-time
paymentobject | nullNoPayment document, or null for a non-payment event. GET /events does not return contract/notice payloads.
sandboxbooleanNoTest event; omission means false.
project_idstringNoOpaque identifier; keep it as a string.
minLength: 1
project_namestringNoProject name.
urlstringNoLink to the Account event.
uri
contractobjectNo
modestringNolive or test.
live, test
ID

Opaque identifier. Its format is not guaranteed; do not convert to a number.

string Opaque identifier. Its format is not guaranteed; do not convert to a number.

EventPayment

REST/SSE payment document. Fields depend on the event and network; not the normalized webhook v1 shape.

FieldTypeRequiredDescription
tx_idstringNoTransaction identifier.
indexintegerNoTransfer index within the transaction.
minimum: 0
heightintegerNoBlock height, when known.
minimum: 0
addressstringNoObserved address.
assetstringNoREST/SSE asset: string identifier, not the webhook asset object.
amount_rawstringNoInteger smallest-unit amount as a string.
pattern: ^[0-9]+$
amountstringNoExact decimal amount as a string; do not use floating point.
pattern: ^[0-9]+(?:\.[0-9]+)?$
decimalsintegerNoDecimal places.
minimum: 0
confirmationsintegerNoConfirmations.
minimum: 0
revisionintegerNoTransfer state revision.
minimum: 0
directionstringNoDirection relative to the observed address.
in, out
simulatedbooleanNoSimulated event.
latebooleanNoLate detected transfer.
block_hashstringNoBlock hash.
match_keystringNoMatch identifier when used by the network.
metaobjectNo
invoiceobjectNo
customerobjectNo
productobjectNo
payerobjectNo
metadataobjectNo
RawAmount

string

Decimal

string

StringMap

object

Customer

FieldTypeRequiredDescription
idstringYesCustomer identifier in your system.
maxLength: 120
Product

FieldTypeRequiredDescription
idstringNoProduct identifier in your system.
maxLength: 120
namestringNoProduct name.
maxLength: 200
quantityintegerNoQuantity.
minimum: 1; maximum: 1000000
Payer

FieldTypeRequiredDescription
commentstringYesPayer comment.
maxLength: 500
Error

FieldTypeRequiredDescription
errorobjectYes