Type alias StakeAPIClient

StakeAPIClient: {
    buildStakingOperation(buildStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
    fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>;
    fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>;
    getExternalStakingOperation(networkId, addressId, stakingOperationID, options?): AxiosPromise<StakingOperation>;
    getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>;
    getValidator(networkId, assetId, id, options?): AxiosPromise<Validator>;
    listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>;
}

Type declaration

buildStakingOperation:function
- buildStakingOperation(buildStakingOperationRequest, options?): AxiosPromise<StakingOperation>
- Build a new staking operation.
  Parameters
  - buildStakingOperationRequest: BuildStakingOperationRequest
    The request to build a staking operation.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<StakingOperation>
  Throws
  If the request fails.
  - Defined in src/coinbase/types.ts:576
fetchHistoricalStakingBalances:function
- fetchHistoricalStakingBalances(networkId, assetId, addressId, startTime, endTime, limit?, page?, options?): AxiosPromise<FetchHistoricalStakingBalances200Response>
- Get the staking balances for an address.
  Parameters
  - networkId: string
    The ID of the blockchain network.
  - assetId: string
    The ID of the asset to fetch the staking balances for.
  - addressId: string
    The onchain address to fetch the staking balances for.
  - startTime: string
    The start time of the staking balances.
  - endTime: string
    The end time of the staking balances.
  - Optional limit: number
    The amount of records to return in a single call.
  - Optional page: string
    The batch of records for a given section in the response.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<FetchHistoricalStakingBalances200Response>
  - Defined in src/coinbase/types.ts:636
fetchStakingRewards:function
- fetchStakingRewards(fetchStakingRewardsRequest, limit?, page?, options?): AxiosPromise<FetchStakingRewards200Response>
- Get the staking rewards for an address.
  Parameters
  - fetchStakingRewardsRequest: FetchStakingRewardsRequest
    The request to get the staking rewards for an address.
  - Optional limit: number
    The amount of records to return in a single call.
  - Optional page: string
    The batch of records for a given section in the response.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<FetchStakingRewards200Response>
  - Defined in src/coinbase/types.ts:617
getExternalStakingOperation:function
- getExternalStakingOperation(networkId, addressId, stakingOperationID, options?): AxiosPromise<StakingOperation>
- Get a staking operation.
  Parameters
  - networkId: string
    The ID of the blockchain network
  - addressId: string
    The ID of the address the staking operation corresponds to.
  - stakingOperationID: string
    The ID of the staking operation to fetch.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<StakingOperation>
  Throws
  If the request fails.
  - Defined in src/coinbase/types.ts:590
getStakingContext:function
- getStakingContext(getStakingContextRequest, options?): AxiosPromise<StakingContext>
- Get staking context for an address.
  Parameters
  - getStakingContextRequest: GetStakingContextRequest
    The request to get the staking context for an address.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<StakingContext>
  Throws
  If the request fails.
  - Defined in src/coinbase/types.ts:604
getValidator:function
- getValidator(networkId, assetId, id, options?): AxiosPromise<Validator>
- Get the validator for a given network, asset, and address.
  Parameters
  - networkId: string
    The ID of the blockchain network.
  - assetId: string
    The ID of the asset to fetch the validator for.
  - id: string
    The unique publicly identifiable id of the validator for which to fetch the data.
  - Optional options: RawAxiosRequestConfig
    Axios request options.
  Returns AxiosPromise<Validator>
  - Defined in src/coinbase/types.ts:674
listValidators:function
- listValidators(networkId, assetId, status?, limit?, page?, options?): AxiosPromise<ValidatorList>
- List the validators for a given network and asset.
  Parameters
  - networkId: string
    The ID of the blockchain network.
  - assetId: string
    The ID of the asset to fetch the validator for.
  - Optional status: ValidatorStatus
    The status to filter by.
  - Optional limit: number
    The amount of records to return in a single call.
  - Optional page: string
    The batch of records for a given section in the response.
  - Optional options: AxiosRequestConfig<any>
    Axios request options.
  Returns AxiosPromise<ValidatorList>
  - Defined in src/coinbase/types.ts:657

Type alias StakeAPIClient

Type declaration

buildStakingOperation:function

Parameters

Returns AxiosPromise<StakingOperation>

Throws

fetchHistoricalStakingBalances:function

Parameters

Returns AxiosPromise<FetchHistoricalStakingBalances200Response>

fetchStakingRewards:function

Parameters

Returns AxiosPromise<FetchStakingRewards200Response>

getExternalStakingOperation:function

Parameters

Returns AxiosPromise<StakingOperation>

Throws

getStakingContext:function

Parameters

Returns AxiosPromise<StakingContext>

Throws

getValidator:function

Parameters

Returns AxiosPromise<Validator>

listValidators:function

Parameters

Returns AxiosPromise<ValidatorList>

Settings

Member Visibility

Theme