Substreams Clock API

Block & Timestamps API

REST API

Pathname	Description
GET /chains	Available chains
GET /block	Get block by block_number, block_id or timestamp
GET /trace_calls	Get aggregate of trace_calls for given time range filtered by chain
GET /transaction_traces	Get aggregate of transaction_traces for given time range filtered by chain
GET /uaw	Get daily unique active wallets for given time range filtered by chain
GET /health	Health check
GET /metrics	Prometheus metrics
GET /openapi	OpenAPI v3 JSON

Important note regarding timestamp query parameter

Expects UTC datetime or UNIX-like timestamp for matching the data in the Clickhouse DB. Passing timestamp data with additional timezone information (such as ...T...Z or ±hh) will likely fail the query to match (unless it corresponds to UTC0).

Requirements

• ClickHouse
• Substreams Sink ClickHouse

Quickstart

$ bun install
$ bun dev

Bun Binary Releases

Linux Only

$ wget https://github.com/pinax-network/substreams-clock-api/releases/download/v0.2.0/substreams-clock-api
$ chmod +x ./substreams-clock-api

.env Environment variables

# API Server
PORT=8080
HOSTNAME=localhost

# Clickhouse Database
HOST=http://127.0.0.1:8123
DATABASE=default
USERNAME=default
PASSWORD=
TABLE=blocks
MAX_LIMIT=500

# Logging
VERBOSE=true

Help

$ ./substreams-clock-api -h
Usage: substreams-clock-api [options]

Block & Timestamps API

Options:
  -V, --version            output the version number
  -p, --port <number>      HTTP port on which to attach the API (default: "8080", env: PORT)
  -v, --verbose <boolean>  Enable verbose logging (choices: "true", "false", default: false, env: VERBOSE)
  --hostname <string>      Server listen on HTTP hostname (default: "localhost", env: HOSTNAME)
  --host <string>          Database HTTP hostname (default: "http://localhost:8123", env: HOST)
  --username <string>      Database user (default: "default", env: USERNAME)
  --password <string>      Password associated with the specified username (default: "", env: PASSWORD)
  --database <string>      The database to use inside ClickHouse (default: "default", env: DATABASE)
  --table <string>         Clickhouse table name (default: "blocks", env: TABLE)
  --max-limit <number>     Maximum LIMIT queries (default: 500, env: MAX_LIMIT)
  -h, --help               display help for command

Docker environment

Pull from GitHub Container registry

docker pull ghcr.io/pinax-network/substreams-clock-api:latest

Build from source

docker build -t substreams-clock-api .

Run with .env file

docker run -it --rm --env-file .env ghcr.io/pinax-network/substreams-clock-api