Class PolkawatchApi

PolkawatchApi - object-oriented interface

Export

Hierarchy

BaseAPI
- PolkawatchApi

Constructors

constructor

new PolkawatchApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): PolkawatchApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PolkawatchApi
Inherited from BaseAPI.constructor
- Defined in packages/ddp-client/base.ts:52

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

ddpIpfsAboutChain

ddpIpfsAboutChain(options?: AxiosRequestConfig<any>): Promise<AxiosResponse<ChainMetadata, any>>
Throws

Memberof
PolkawatchApi
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ChainMetadata, any>>
- Defined in packages/ddp-client/api.ts:2462

ddpIpfsAboutDataset

ddpIpfsAboutDataset(requestParameters: PolkawatchApiDdpIpfsAboutDatasetRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<AboutData, any>>
Returns information about the dataset of the last N days.

Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsAboutDatasetRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AboutData, any>>
- Defined in packages/ddp-client/api.ts:2473

ddpIpfsAboutDatasetQuality

ddpIpfsAboutDatasetQuality(requestParameters: PolkawatchApiDdpIpfsAboutDatasetQualityRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<AboutDataQuality, any>>
Returns information about the dataset quality of the last N days.

Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsAboutDatasetQualityRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AboutDataQuality, any>>
- Defined in packages/ddp-client/api.ts:2484

ddpIpfsAboutInventory

ddpIpfsAboutInventory(requestParameters: PolkawatchApiDdpIpfsAboutInventoryRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<InventoryRecord[], any>>
Identifiers of participating entities. Available only for 60 days and public validation.

Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsAboutInventoryRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<InventoryRecord[], any>>
- Defined in packages/ddp-client/api.ts:2495

ddpIpfsCountryDetail

ddpIpfsCountryDetail(requestParameters: PolkawatchApiDdpIpfsCountryDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<CountryDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsCountryDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CountryDetail, any>>
- Defined in packages/ddp-client/api.ts:2506

ddpIpfsGeoRegionOverview

ddpIpfsGeoRegionOverview(requestParameters: PolkawatchApiDdpIpfsGeoRegionOverviewRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<GeoRegionOverview, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsGeoRegionOverviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<GeoRegionOverview, any>>
- Defined in packages/ddp-client/api.ts:2517

ddpIpfsNetworkDetail

ddpIpfsNetworkDetail(requestParameters: PolkawatchApiDdpIpfsNetworkDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<NetworkDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsNetworkDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<NetworkDetail, any>>
- Defined in packages/ddp-client/api.ts:2528

ddpIpfsNetworkOverview

ddpIpfsNetworkOverview(requestParameters: PolkawatchApiDdpIpfsNetworkOverviewRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<NetworkOverview, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsNetworkOverviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<NetworkOverview, any>>
- Defined in packages/ddp-client/api.ts:2539

ddpIpfsNominatorDetail

ddpIpfsNominatorDetail(requestParameters: PolkawatchApiDdpIpfsNominatorDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<NominatorDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsNominatorDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<NominatorDetail, any>>
- Defined in packages/ddp-client/api.ts:2550

ddpIpfsOperatorDetail

ddpIpfsOperatorDetail(requestParameters: PolkawatchApiDdpIpfsOperatorDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<OperatorDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsOperatorDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OperatorDetail, any>>
- Defined in packages/ddp-client/api.ts:2561

ddpIpfsOperatorOverview

ddpIpfsOperatorOverview(requestParameters: PolkawatchApiDdpIpfsOperatorOverviewRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<OperatorOverview, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsOperatorOverviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OperatorOverview, any>>
- Defined in packages/ddp-client/api.ts:2572

ddpIpfsPoolDetail

ddpIpfsPoolDetail(requestParameters: PolkawatchApiDdpIpfsPoolDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<PoolInstanceDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsPoolDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PoolInstanceDetail, any>>
- Defined in packages/ddp-client/api.ts:2583

ddpIpfsPoolOperatorDetail

ddpIpfsPoolOperatorDetail(requestParameters: PolkawatchApiDdpIpfsPoolOperatorDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<PoolOperatorDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsPoolOperatorDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PoolOperatorDetail, any>>
- Defined in packages/ddp-client/api.ts:2594

ddpIpfsPoolOverview

ddpIpfsPoolOverview(requestParameters: PolkawatchApiDdpIpfsPoolOverviewRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<PoolOverview, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsPoolOverviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PoolOverview, any>>
- Defined in packages/ddp-client/api.ts:2605

ddpIpfsRegionDetail

ddpIpfsRegionDetail(requestParameters: PolkawatchApiDdpIpfsRegionDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<RegionDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsRegionDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<RegionDetail, any>>
- Defined in packages/ddp-client/api.ts:2616

ddpIpfsValidatorDetail

ddpIpfsValidatorDetail(requestParameters: PolkawatchApiDdpIpfsValidatorDetailRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<ValidatorDetail, any>>
Throws

Memberof
PolkawatchApi
Parameters
- requestParameters: PolkawatchApiDdpIpfsValidatorDetailRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ValidatorDetail, any>>
- Defined in packages/ddp-client/api.ts:2627

Class PolkawatchApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns PolkawatchApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

ddpIpfsAboutChain

Throws

Memberof

Parameters

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<ChainMetadata, any>>

ddpIpfsAboutDataset

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsAboutDatasetRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<AboutData, any>>

ddpIpfsAboutDatasetQuality

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsAboutDatasetQualityRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<AboutDataQuality, any>>

ddpIpfsAboutInventory

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsAboutInventoryRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<InventoryRecord[], any>>

ddpIpfsCountryDetail

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsCountryDetailRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CountryDetail, any>>

ddpIpfsGeoRegionOverview

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsGeoRegionOverviewRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<GeoRegionOverview, any>>

ddpIpfsNetworkDetail

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsNetworkDetailRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<NetworkDetail, any>>

ddpIpfsNetworkOverview

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsNetworkOverviewRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<NetworkOverview, any>>

ddpIpfsNominatorDetail

Throws

Memberof

Parameters

requestParameters: PolkawatchApiDdpIpfsNominatorDetailRequest

Optional options: AxiosRequestConfig<any>

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>