Function PolkawatchApiFactory

  • PolkawatchApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

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

    • ddpIpfsAboutChain:function
      • Throws

        Parameters

        • Optional options: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns AxiosPromise<NetworkOverview>

    • ddpIpfsNominatorDetail:function
      • Throws

        Parameters

        • lastDays: 30

          Available set of days to query

        • nominator: any

          Nominator ID to request

        • Optional options: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns 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: any

          Override http request option.

        Returns AxiosPromise<ValidatorDetail>

Generated using TypeDoc