Class BlockchainData

constructor

• new BlockchainData(moduleConfig): BlockchainData

• Parameters

  • moduleConfig: BlockchainDataModuleConfiguration

  Returns BlockchainData

Readonlyconfig

listActivities

• listActivities(request): Promise<ListActivitiesResult>

• List all activities

  Parameters

  • request: ListActivitiesRequestParams

    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

listActivityHistory

• listActivityHistory(request): Promise<ListActivitiesResult>

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

  Parameters

  • request: ListActivityHistoryRequestParams

    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

getActivity

• getActivity(request): Promise<GetActivityResult>

• Get a single activity by ID

  Parameters

  • request: GetActivityRequestParams

    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

listChains

• listChains(request): Promise<ListChainsResult>

• List supported chains

  Parameters

  • request: ListChainsRequestParams

    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

listCollections

• listCollections(request): Promise<ListCollectionsResult>

• List all collections

  Parameters

  • request: ListCollectionsRequestParams

    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

listCollectionsByNFTOwner

• listCollectionsByNFTOwner(request): Promise<ListCollectionsResult>

• List collections by NFT owner

  Parameters

  • request: ListCollectionsByNFTOwnerRequestParams

    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

getCollection

• getCollection(request): Promise<GetCollectionResult>

• Get a collection by contract address

  Parameters

  • request: GetCollectionRequestParams

    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

getNFT

• getNFT(request): Promise<GetNFTResult>

• Get NFT by token ID

  Parameters

  • request: GetNFTRequestParams

    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

listNFTs

• listNFTs(request): Promise<ListNFTsResult>

• List NFTs by contract address

  Parameters

  • request: ListNFTsRequestParams

    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

listNFTsByAccountAddress

• listNFTsByAccountAddress(request): Promise<ListNFTsByOwnerResult>

• List NFTs by account address

  Parameters

  • request: ListNFTsByAccountAddressRequestParams

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

  Returns Promise<ListNFTsByOwnerResult>

  a promise that resolves with a list of NFTs

  Throws

  index.APIError

listAllNFTs

• listAllNFTs(request): Promise<ListNFTsResult>

• List All NFTs on a chain

  Parameters

  • request: ListAllNFTsRequestParams

    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

createMintRequest

• createMintRequest(request): Promise<CreateMintRequestResult>

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

  Parameters

  • request: CreateMintRequestRequestParams

    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

listMintRequests

• listMintRequests(request): Promise<ListMintRequestsResult>

• List all mint requests for a given contract address

  Parameters

  • request: ListMintRequestsRequestParams

    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

getMintRequest

• getMintRequest(request): Promise<ListMintRequestsResult>

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

  Parameters

  • request: GetMintRequestRequestParams

    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

listNFTOwners

• listNFTOwners(request): Promise<ListNFTOwnersResult>

• List NFT owners by token ID

  Parameters

  • request: ListNFTOwnersRequestParams

    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

listNFTOwnersByContractAddress

• listNFTOwnersByContractAddress(request): Promise<ListNFTOwnersResult>

• List NFT owners by contract address

  Parameters

  • request: ListOwnersByContractAddressRequestParams

    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

listAllNFTOwners

• listAllNFTOwners(request): Promise<ListNFTOwnersResult>

• List All NFT owners on a chain

  Parameters

  • request: ListAllNFTOwnersRequestParams

    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

listTokens

• listTokens(request): Promise<ListTokensResult>

• List ERC20 Token contracts

  Parameters

  • request: ListERC20TokensRequestParams

    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

getToken

• getToken(request): Promise<GetTokenResult>

• Get details for an ERC20 Token by contract address

  Parameters

  • request: GetERC20TokenRequestParams

    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

getMetadata

• getMetadata(request): Promise<GetMetadataResult>

• Get metadata by ID

  Parameters

  • request: GetMetadataRequestParams

    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

listNFTMetadataByContractAddress

• listNFTMetadataByContractAddress(request): Promise<ListMetadataResult>

• List NFT Metadata by contract address

  Parameters

  • request: ListMetadataRequestParams

    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

listNFTMetadataByChain

• listNFTMetadataByChain(request): Promise<ListMetadataResult>

• List NFT Metadata by chain

  Parameters

  • request: ListMetadataForChainRequestParams

    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

refreshCollectionMetadata

• refreshCollectionMetadata(request): Promise<RefreshCollectionMetadataResult>

• Refresh collection metadata

  Parameters

  • request: RefreshCollectionMetadataRequestParams

    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

refreshNFTMetadata

• refreshNFTMetadata(request): Promise<MetadataRefreshRateLimitResult>

• Refresh metadata for specific NFTs

  Parameters

  • request: RefreshNFTMetadataByTokenIDRequestParams

    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

refreshStackedMetadata

• refreshStackedMetadata(request): Promise<MetadataRefreshRateLimitResult>

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

  Parameters

  • request: RefreshMetadataByIDRequestParams

    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

signCraftingPayload

• signCraftingPayload(request): Promise<SignCraftingResult>

• Sign a crafting payload

  Parameters

  • request: SignCraftingPayloadRequestParams

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

  Returns Promise<SignCraftingResult>

  a promise that resolves with the signature result

  Throws

  index.APIError

listFilters

• listFilters(request): Promise<ListFiltersResult>

• Get list of metadata filters

  Parameters

  • request: ListFiltersRequestParams

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

  Returns Promise<ListFiltersResult>

  a promise that resolves with the a list of metadata filters

  Throws

  index.APIError

searchNFTs

• searchNFTs(request): Promise<SearchNFTsResult>

• Search NFTs

  Parameters

  • request: SearchNFTsRequestParams

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

  Returns Promise<SearchNFTsResult>

  a promise that resolves with the a list NFTs with metadata, market and listings information

  Throws

  index.APIError

searchStacks

• searchStacks(request): Promise<SearchStacksResult>

• Search NFT stacks

  Parameters

  • request: SearchStacksRequestParams

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

  Returns Promise<SearchStacksResult>

  a promise that resolves with the a list NFT stacks with stack count, market and listings information

  Throws

  index.APIError

quotesForNFTs

• quotesForNFTs(request): Promise<QuotesForNFTsResult>

• Get pricing data for a list of token ids

  Parameters

  • request: QuotesForNFTsRequestParams

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

  Returns Promise<QuotesForNFTsResult>

  a promise that resolves with the a list of pricing data for particular NFTs

  Throws

  index.APIError

quotesForStacks

• quotesForStacks(request): Promise<QuotesForStacksResult>

• Get pricing data for a list of stack ids

  Parameters

  • request: QuotesForStacksRequestParams

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

  Returns Promise<QuotesForStacksResult>

  a promise that resolves with the a list of pricing data for particular stack ids

  Throws

  index.APIError

listStacks

• listStacks(request): Promise<StackBundle[]>

• List NFT stack bundles by stack_id.

  Parameters

  • request: ListStacksRequestParams

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

  Returns Promise<StackBundle[]>

  a promise that resolves with a list of NFT stacks with stack count, market and listings information

  Throws

  index.APIError