List events
GET/v1/events
Contract v1 / 1.0.0 62 / 2026-10-10
On this page
Event history within the key's scope, retained for 30 days. No date filter; paginate with before. Service-scoped keys restrict their service. Non-payment events have payment:null; no additional contract/notice body is returned.
Key permissions: events / read.
Parameters
| Parameter | In | Required | Description |
|---|---|---|---|
project | query | No | Project ID. Required for listing or creating watches unless the key is project-scoped. For other operations omission uses the operation's account/project context; set it explicitly.string |
watch_id | query | No | Project watch ID.string |
chain | query | No | Network code filter.string |
type | query | No | Event type, such as payment.confirmed.string |
address | query | No | Address.string |
tx_id | query | No | Transaction ID.string |
limit | query | No | Page size: at most 200. Invalid values use the default; values above 200 are capped.integer Default: 25; minimum: 1; maximum: 200 |
before | query | No | Cursor from next_before or the last item's ID on the previous page; newest first.string minLength: 1 |
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.
#!/usr/bin/env bash
set -euo pipefail
: "${CRYPTANIO_PROJECT_ID:?Set CRYPTANIO_PROJECT_ID}"
: "${CRYPTANIO_API_KEY:?Set CRYPTANIO_API_KEY}"
response_file="$(mktemp)"
trap 'rm -f "$response_file"' EXIT
transfer_status=0
http_status="$(curl \
--silent --show-error --max-time 30 --request GET \
--header "Authorization: Bearer $CRYPTANIO_API_KEY" \
--header 'Accept: application/json' \
--get \
--data-urlencode "project=$CRYPTANIO_PROJECT_ID" \
--data-urlencode 'limit=25' \
"https://api.cryptanio.com/v1/events" \
--output "$response_file" --write-out '%{http_code}')" || transfer_status=$?
if [[ "$http_status" == 2?? ]]; then
cat "$response_file"
exit "$transfer_status"
fi
printf 'HTTP %s\n' "$http_status" >&2
cat "$response_file" >&2
exit 1
// 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/events"
endpoint, err := url.Parse("https://api.cryptanio.com" + path)
if err != nil { return err }
query := endpoint.Query()
query.Set("project", env("CRYPTANIO_PROJECT_ID"))
query.Set("limit", "25")
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", "application/json")
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) }
}
// 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("events");
}
url.query_pairs_mut()
.append_pair("project", &env("CRYPTANIO_PROJECT_ID")?)
.append_pair("limit", &"25".to_owned());
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", "application/json".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 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/events';
$query = [
'project' => env('CRYPTANIO_PROJECT_ID'),
'limit' => '25',
];
$url = 'https://api.cryptanio.com' . $path . ($query ? '?' . http_build_query($query, '', '&', PHP_QUERY_RFC3986) : '');
$headers = [
'Authorization: ' . 'Bearer ' . env('CRYPTANIO_API_KEY'),
'Accept: ' . 'application/json',
];
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 10,
CURLOPT_TIMEOUT => 30,
]);
$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 . ': ' . $response);
echo $response;
} catch (Throwable $error) {
fwrite(STDERR, $error->getMessage() . PHP_EOL);
exit(1);
}
# 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/events"
query = {
"project": env("CRYPTANIO_PROJECT_ID"),
"limit": "25",
}
url = "https://api.cryptanio.com" + path + ("?" + urlencode(query) if query else "")
headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
}
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))
sys.stdout.buffer.write(response.read())
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 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/events";
const url = new URL(path, "https://api.cryptanio.com");
url.searchParams.set("project", env("CRYPTANIO_PROJECT_ID"));
url.searchParams.set("limit", "25");
const headers = {
"Authorization": "Bearer " + env("CRYPTANIO_API_KEY"),
"Accept": "application/json",
};
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;
}
Responses and errors
200 Successful response.
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | |
next_before | string | No | Next-page cursor; only present when more pages exist. minLength: 1 |
401 No valid active API key (unauthorized).
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}403 Key disallows the operation, project, service or IP; email unconfirmed.
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}429 Too many requests (rate_limited); retry after Retry-After.
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}500 Internal error (internal).
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}503 Temporary unavailability (unavailable); retry with backoff.
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |
{
"error": {
"code": "forbidden",
"message": "this API key is read-only"
}
}Nested objects
EventList
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | |
next_before | string | No | Next-page cursor; only present when more pages exist. minLength: 1 |
Event
| Field | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | Opaque identifier; keep it as a string. minLength: 1 |
event_type | string | Yes | Event type; new types may be added. |
chain | string | Yes | Network code. |
service | string | No | Service, when known. |
watch_id | string | No | Project watch ID, when linked to a watch. minLength: 1 |
occurred_at | string | Yes | UTC date and time in RFC 3339.date-time |
payment | object | null | Yes | Payment document, or null for a non-payment event. GET /events does not return contract/notice payloads. |
sandbox | boolean | No | Test event; omission means false. |
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.
| Field | Type | Required | Description |
|---|---|---|---|
tx_id | string | No | Transaction identifier. |
index | integer | No | Transfer index within the transaction. minimum: 0 |
height | integer | No | Block height, when known. minimum: 0 |
address | string | No | Observed address. |
asset | string | No | REST/SSE asset: string identifier, not the webhook asset object. |
amount_raw | string | No | Integer smallest-unit amount as a string. pattern: ^[0-9]+$ |
amount | string | No | Exact decimal amount as a string; do not use floating point. pattern: ^[0-9]+(?:\.[0-9]+)?$ |
decimals | integer | No | Decimal places. minimum: 0 |
confirmations | integer | No | Confirmations. minimum: 0 |
revision | integer | No | Transfer state revision. minimum: 0 |
direction | string | No | Direction relative to the observed address.in, out |
simulated | boolean | No | Simulated event. |
late | boolean | No | Late detected transfer. |
block_hash | string | No | Block hash. |
match_key | string | No | Match identifier when used by the network. |
meta | object | No | |
invoice | object | No | |
customer | object | No | |
product | object | No | |
payer | object | No | |
metadata | object | No |
RawAmount
string
Decimal
string
StringMap
object
Customer
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Customer identifier in your system. maxLength: 120 |
Product
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Product identifier in your system. maxLength: 120 |
name | string | No | Product name. maxLength: 200 |
quantity | integer | No | Quantity. minimum: 1; maximum: 1000000 |
Payer
| Field | Type | Required | Description |
|---|---|---|---|
comment | string | Yes | Payer comment. maxLength: 500 |
Error
| Field | Type | Required | Description |
|---|---|---|---|
error | object | Yes |