Class KeyEndpoint

Access the Key API endpoints

Index

Constructors

Methods

Constructors

constructor

new KeyEndpoint(requester: Requester): KeyEndpoint
Parameters
- requester: Requester
Returns KeyEndpoint
- Defined in src/generated/endpoints/key.ts:16

Methods

get

get(
    params?: {
        limit?: number;
        offset?: number;
        selections?: string[];
        timestamp?: string | number;
    },
): Promise<KeyResponse>
Get any Key selection
Parameters
- Optionalparams: {
      limit?: number;
      offset?: number;
      selections?: string[];
      timestamp?: string | number;
  }
  Optional query parameters
Returns Promise<KeyResponse>
- Defined in src/generated/endpoints/key.ts:56

info

info(params?: { timestamp?: string | number }): Promise<KeyInfoResponse>
Get current key info
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<KeyInfoResponse>
- Defined in src/generated/endpoints/key.ts:42

log

log(
    params?: {
        limit?: number;
        offset?: number;
        timestamp?: string | number;
    },
): Promise<KeyLogResponse>
Get current key log history
Parameters
- Optionalparams: { limit?: number; offset?: number; timestamp?: string | number }
  Optional query parameters
Returns Promise<KeyLogResponse>
- Defined in src/generated/endpoints/key.ts:24