Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OpenSeaAPI

Hierarchy

  • OpenSeaAPI

Index

Constructors

constructor

Properties

apiBaseUrl

apiBaseUrl: string

hostUrl

hostUrl: string

logger

logger: function

Type declaration

    • (arg: string): void
    • Parameters

      • arg: string

      Returns void

pageSize

pageSize: number = 20

Methods

get

  • get(apiPath: string, query?: object): Promise<any>
  • Parameters

    • apiPath: string
    • Default value query: object = {}

    Returns Promise<any>

getAsset

  • getAsset(__namedParameters: object, retries?: number): Promise<OpenSeaAsset>
  • Parameters

    • __namedParameters: object
      • tokenAddress: string
      • tokenId: null | string | number
    • Default value retries: number = 1

    Returns Promise<OpenSeaAsset>

getAssets

  • Parameters

    Returns Promise<object>

getBundle

getBundles

getOrder

getOrders

  • getOrders(query?: OrderQuery, page?: number): Promise<object>
  • Parameters

    • Default value query: OrderQuery = {}
    • Default value page: number = 1

    Returns Promise<object>

getPaymentTokens

  • Parameters

    Returns Promise<object>

post

  • post(apiPath: string, body?: undefined | object, opts?: RequestInit): Promise<any>
  • Parameters

    • apiPath: string
    • Optional body: undefined | object
    • Default value opts: RequestInit = {}

    Returns Promise<any>

postAssetWhitelist

  • postAssetWhitelist(tokenAddress: string, tokenId: string | number, email: string): Promise<boolean>
  • Parameters

    • tokenAddress: string
    • tokenId: string | number
    • email: string

    Returns Promise<boolean>

postOrder

put

  • put(apiPath: string, body: object, opts?: RequestInit): Promise<any>
  • Parameters

    • apiPath: string
    • body: object
    • Default value opts: RequestInit = {}

    Returns Promise<any>

Generated using TypeDoc