Options
All
  • Public
  • Public/Protected
  • All
Menu

Class API

Mintbase API. Main entry point for users read Mintbase data.

Hierarchy

  • API

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiBaseUrl

apiBaseUrl: string = ...

chainName

chainName: string = ...

constants

constants: Constants

defaultLimit

defaultLimit: number = 20

networkName

networkName: undefined | Network

Methods

custom

  • custom<T>(query: string, variables?: unknown): Promise<ResponseData<T>>

  • Makes custom GraphQL query

    Type parameters

    • T

    Parameters

    • query: string

      custom GraphQL query

    • Optional variables: unknown

      object with variables passed to the query

    Returns Promise<ResponseData<T>>

    result of query

fetchAccount

  • fetchAccount(accountId: string): Promise<ResponseData<any>>

fetchApprovals

  • fetchApprovals(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Parameters

    • Optional offset: number
    • Optional limit: number

    Returns Promise<ResponseData<any>>

fetchCategories

fetchListById

fetchLists

  • fetchLists(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Parameters

    • Optional offset: number
    • Optional limit: number

    Returns Promise<ResponseData<any>>

fetchMarketplace

  • fetchMarketplace(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Fetch marketplace and each token's metadata (w/ cursor offset pagination enabled).

    Parameters

    • Optional offset: number

      number of records to skip

    • Optional limit: number

      number of results

    Returns Promise<ResponseData<any>>

fetchMetadata

  • Fetch metadata from Arweave

    Parameters

    • url: string

    Returns Promise<ResponseData<any>>

    metadata

fetchStats

fetchStoreById

  • fetchStoreById(storeId: string): Promise<ResponseData<any>>

fetchStores

  • fetchStores(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Parameters

    • Optional offset: number
    • Optional limit: number

    Returns Promise<ResponseData<any>>

fetchThingById

  • fetchThingById(thingId: string): Promise<ResponseData<any>>

  • Fetch thing by Id TODO: Not yet implemented

    Parameters

    • thingId: string

    Returns Promise<ResponseData<any>>

fetchThingMetadata

fetchThings

  • fetchThings(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Fetch thing.

    Parameters

    • Optional offset: number
    • Optional limit: number

    Returns Promise<ResponseData<any>>

fetchTokenApprovals

  • fetchTokenApprovals(tokenKey: string, contractAddress: string): Promise<ResponseData<any>>

  • Parameters

    • tokenKey: string
    • contractAddress: string

    Returns Promise<ResponseData<any>>

fetchTokenById

  • fetchTokenById(tokenId: string): Promise<ResponseData<any>>

  • Fetch token

    Parameters

    • tokenId: string

      token id

    Returns Promise<ResponseData<any>>

    the token data

fetchTokens

  • fetchTokens(offset?: number, limit?: number): Promise<ResponseData<any>>

  • Parameters

    • Optional offset: number
    • Optional limit: number

    Returns Promise<ResponseData<any>>

isTokenOwner

  • isTokenOwner(accountId: string, tokenKey: string): Promise<ResponseData<boolean>>

  • Checks whether account owns a token or not.

    Parameters

    • accountId: string

      account id

    • tokenKey: string

    Returns Promise<ResponseData<boolean>>

    whether an account owns a token or not.

Generated using TypeDoc