Function PolkawatchApiFp

  • PolkawatchApi - functional programming interface

    Export

    Parameters

    Returns {
        ddpIpfsAboutChain(options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChainMetadata>)>;
        ddpIpfsAboutDataset(lastDays: 30 | 60, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutData>)>;
        ddpIpfsAboutDatasetQuality(lastDays: 30 | 60, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutDataQuality>)>;
        ddpIpfsAboutInventory(recordType: "network" | "region" | "country" | "operator" | "validator" | "pool_operator" | "pool" | "nominator", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryRecord[]>)>;
        ddpIpfsCountryDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", country: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryDetail>)>;
        ddpIpfsGeoRegionOverview(lastDays: 30 | 60, topResults: 3 | 4 | 5, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeoRegionOverview>)>;
        ddpIpfsNetworkDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", network: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkDetail>)>;
        ddpIpfsNetworkOverview(lastDays: 30 | 60, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkOverview>)>;
        ddpIpfsNominatorDetail(lastDays: 30, nominator: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NominatorDetail>)>;
        ddpIpfsOperatorDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", operator: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperatorDetail>)>;
        ddpIpfsOperatorOverview(lastDays: 30 | 60, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperatorOverview>)>;
        ddpIpfsPoolDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", pool: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolInstanceDetail>)>;
        ddpIpfsPoolOperatorDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", poolOperator: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolOperatorDetail>)>;
        ddpIpfsPoolOverview(lastDays: 30 | 60, validationType: "all" | "public" | "authority", options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolOverview>)>;
        ddpIpfsRegionDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", region: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegionDetail>)>;
        ddpIpfsValidatorDetail(lastDays: 30 | 60, validationType: "all" | "public" | "authority", validator: any, options?: AxiosRequestConfig<any>): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidatorDetail>)>;
    }

    • ddpIpfsAboutChain:function
      • Throws

        Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChainMetadata>)>

    • ddpIpfsAboutDataset:function
      • Returns information about the dataset of the last N days.

        Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutData>)>

    • ddpIpfsAboutDatasetQuality:function
      • Returns information about the dataset quality of the last N days.

        Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutDataQuality>)>

    • ddpIpfsAboutInventory:function
      • Identifiers of participating entities. Available only for 60 days and public validation.

        Throws

        Parameters

        • recordType: "network" | "region" | "country" | "operator" | "validator" | "pool_operator" | "pool" | "nominator"

          The record type to get Identifiers from

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryRecord[]>)>

    • ddpIpfsCountryDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • country: any

          Country ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryDetail>)>

    • ddpIpfsGeoRegionOverview:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • topResults: 3 | 4 | 5

          Number of top regions

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeoRegionOverview>)>

    • ddpIpfsNetworkDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • network: any

          Network ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkDetail>)>

    • ddpIpfsNetworkOverview:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkOverview>)>

    • ddpIpfsNominatorDetail:function
      • Throws

        Parameters

        • lastDays: 30

          Available set of days to query

        • nominator: any

          Nominator ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<NominatorDetail>)>

    • ddpIpfsOperatorDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • operator: any

          Operator ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperatorDetail>)>

    • ddpIpfsOperatorOverview:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperatorOverview>)>

    • ddpIpfsPoolDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • pool: any

          Pool ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolInstanceDetail>)>

    • ddpIpfsPoolOperatorDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • poolOperator: any

          Pool Operator ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolOperatorDetail>)>

    • ddpIpfsPoolOverview:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolOverview>)>

    • ddpIpfsRegionDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • region: any

          Region ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegionDetail>)>

    • ddpIpfsValidatorDetail:function
      • Throws

        Parameters

        • lastDays: 30 | 60

          Available set of days to query

        • validationType: "all" | "public" | "authority"

          Limit to Staking Rewards of Public Validators with Identity, Aura Authorities, or include ALL rewards and commissions from All validators/collators

        • validator: any

          Validator Node ID to request

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidatorDetail>)>

Generated using TypeDoc