Hierarchy

  • BlockchainData

Constructors

Properties

config: BlockchainDataConfiguration
activities: any
chains: any
collections: any
nfts: any
nftOwners: any
tokens: any
metadata: any

Methods

  • List all activities

    Parameters

    • request: ActivitiesApiListActivitiesRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListActivitiesResult>

    a promise that resolves with a list of activities

    Throws

    index.APIError

  • List activities sorted by updated_at timestamp ascending, useful for time based data replication

    Parameters

    • request: ActivitiesApiListActivityHistoryRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListActivitiesResult>

    a promise that resolves with a list of activities

    Throws

    index.APIError

  • Get a single activity by ID

    Parameters

    • request: ActivitiesApiGetActivityRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<GetActivityResult>

    a promise that resolves with a single activity

    Throws

    index.APIError

  • List supported chains

    Parameters

    • request: ChainsApiListChainsRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListChainsResult>

    a promise that resolves with a list of supported chains

    Throws

    index.APIError

  • List all collections

    Parameters

    • request: CollectionsApiListCollectionsRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListCollectionsResult>

    a promise that resolves with a list of collections

    Throws

    index.APIError

  • List collections by NFT owner

    Parameters

    • request: CollectionsApiListCollectionsByNFTOwnerRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListCollectionsResult>

    a promise that resolves with a list of collections

    Throws

    index.APIError

  • Get a collection by contract address

    Parameters

    • request: CollectionsApiGetCollectionRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<GetCollectionResult>

    a promise that resolves with a single collection

    Throws

    index.APIError

  • Get NFT by token ID

    Parameters

    • request: NftsApiGetNFTRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<GetNFTResult>

    a promise that resolves with a single NFT

    Throws

    index.APIError

  • List NFTs by contract address

    Parameters

    • request: NftsApiListNFTsRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTsResult>

    a promise that resolves with a list of NFTs

    Throws

    index.APIError

  • List NFTs by account address

    Parameters

    • request: NftsApiListNFTsByAccountAddressRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTsResult>

    a promise that resolves with a list of NFTs

    Throws

    index.APIError

  • List All NFTs on a chain

    Parameters

    • request: NftsApiListAllNFTsRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTsResult>

    a promise that resolves with a list of NFTs

    Throws

    index.APIError

  • Create a mint request to mint a set of NFTs for a given collection

    Parameters

    • request: NftsApiCreateMintRequestRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<CreateMintRequestResult>

    a promise that resolves with the remaining rate limits

    Throws

    index.APIError

  • List all mint requests for a given contract address

    Parameters

    • request: NftsApiListMintRequestsRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListMintRequestsResult>

    a promise that resolves with a list of mint requests

    Throws

    index.APIError

  • Retrieve the status of a single mint request identified by its reference ID

    Parameters

    • request: NftsApiGetMintRequestRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListMintRequestsResult>

    a promise that resolves with a single mint request

    Throws

    index.APIError

  • List NFT owners by token ID

    Parameters

    • request: NftOwnersApiListNFTOwnersRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTOwnersResult>

    a promise that resolves with a list of NFT owners

    Throws

    index.APIError

  • List NFT owners by contract address

    Parameters

    • request: NftOwnersApiListOwnersByContractAddressRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTOwnersResult>

    a promise that resolves with a list of NFT owners

    Throws

    index.APIError

  • List All NFT owners on a chain

    Parameters

    • request: NftOwnersApiListNFTOwnersRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListNFTOwnersResult>

    a promise that resolves with a list of NFT owners

    Throws

    index.APIError

  • List ERC20 Token contracts

    Parameters

    • request: TokensApiListERC20TokensRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListTokensResult>

    a promise that resolves with a list of ERC20 Tokens

    Throws

    index.APIError

  • Get details for an ERC20 Token by contract address

    Parameters

    • request: TokensApiGetERC20TokenRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<GetTokenResult>

    a promise that resolves with a list of ERC20 Tokens

    Throws

    index.APIError

  • Get metadata by ID

    Parameters

    • request: MetadataApiGetMetadataRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<GetMetadataResult>

    a promise that resolves with a single Metadata

    Throws

    index.APIError

  • List NFT Metadata by contract address

    Parameters

    • request: MetadataApiListMetadataRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListMetadataResult>

    a promise that resolves with a list of Metadata

    Throws

    index.APIError

  • List NFT Metadata by chain

    Parameters

    • request: MetadataApiListMetadataForChainRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<ListMetadataResult>

    a promise that resolves with a list of Metadata

    Throws

    index.APIError

  • Refresh collection metadata

    Parameters

    • request: CollectionsApiRefreshCollectionMetadataRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<RefreshCollectionMetadataResult>

    a promise that resolves with the updated collection

    Throws

    index.APIError

  • Refresh metadata for specific NFTs

    Parameters

    • request: MetadataApiRefreshNFTMetadataByTokenIDRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<MetadataRefreshRateLimitResult>

    a promise that resolves with the remaining rate limits

    Throws

    index.APIError

  • Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.

    Parameters

    • request: MetadataApiRefreshMetadataByIDRequest

      the request object containing the parameters to be provided in the API request

    Returns Promise<MetadataRefreshRateLimitResult>

    a promise that resolves with the remaining rate limits

    Throws

    index.APIError

Generated using TypeDoc