glassnode-api - v0.29.3
    Preparing search index...

    Interface GlassnodeHookEventBase

    Fields shared by every hook event. Nothing in an event carries the API key: url is masked (api_key=***) and no request or response headers are exposed (so neither the X-Api-Key header nor x402 payment headers). The error of an event is the same object the call rejects with, so the caveat on GlassnodeError applies: its .cause is not redacted.

    Treat every event as read-only. Each hook call gets a fresh event object, but error is the live error (in onError, the very object the caller's promise rejects with); it is neither frozen nor copied, so a hook that mutates it changes what the caller sees.

    interface GlassnodeHookEventBase {
        attempt: number;
        callId: number;
        endpoint: string;
        maxAttempts: number;
        method: "GET";
        url: string;
    }

    Hierarchy (View Summary)

    Index
    attempt callId endpoint maxAttempts method url
    attempt: number

    1-based number of the attempt the event is about. For onError, the last attempt made, or 0 when the call was cancelled before its first attempt.

    callId: number

    Correlation id of the call: every event of one method call (all its attempts and retries) carries the same id, and no other call in this JavaScript realm has it. A process-local counter — add your own prefix if ids must be unique across processes.

    endpoint: string

    API endpoint path, without host or query string (e.g. /v1/metrics/market/price_usd_close).

    maxAttempts: number

    Most attempts this call can make: maxRetries + 1.

    method: "GET"

    HTTP method. The Glassnode API is read-only, so this is always 'GET'.

    url: string

    Full request URL with the API key masked (api_key=***).

    Settings
    Member Visibility

    On This Page
    Properties