Skip to main content

​
Interfaces

​
GetAuthHeadersOptions

Defined in: utils/http.ts:13 Options for generating authentication headers for API requests.

​
Properties

apiKeyId?
Defined in: utils/http.ts:23 The API key ID Examples: ‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’ ‘organizations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/apiKeys/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’ Not required to call public (unauthenticated) endpoints. See isPublicOperation.
apiKeySecret?
Defined in: utils/http.ts:34 The API key secret Examples: ‘xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==’ (Edwards key (Ed25519)) ‘-----BEGIN EC PRIVATE KEY-----\n…\n…\n…==\n-----END EC PRIVATE KEY-----\n’ (EC key (ES256)) Not required to call public (unauthenticated) endpoints. See isPublicOperation.
requestMethod
Defined in: utils/http.ts:39 The HTTP method for the request (e.g. ‘GET’, ‘POST’)
requestHost
Defined in: utils/http.ts:44 The host for the request (e.g. ‘api.cdp.coinbase.com’)
requestPath
Defined in: utils/http.ts:49 The path for the request (e.g. ‘/platform/v1/wallets’)
requestBody?
Defined in: utils/http.ts:54 Optional request body data
walletSecret?
Defined in: utils/http.ts:59 The Wallet Secret for wallet authentication
source?
Defined in: utils/http.ts:64 The source identifier for the request
sourceVersion?
Defined in: utils/http.ts:69 The version of the source making the request
expiresIn?
Defined in: utils/http.ts:74 Optional expiration time in seconds (defaults to 120)
audience?
Defined in: utils/http.ts:79 Optional audience claim for the JWT

​
Functions