index.AssetsApi.md

@standard-crypto/farcaster-js / Modules / index / AssetsApi

Class: AssetsApi

index.AssetsApi

AssetsApi - object-oriented interface

Export

Hierarchy

• BaseAPI

  ↳ AssetsApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• v2AssetEventsGet
• v2AssetGet
• v2CollectionActivityGet
• v2CollectionAssetsGet
• v2CollectionGet
• v2CollectionOwnersGet
• v2UserCollectionsGet

Constructors

constructor

• new AssetsApi(configuration?, basePath?, axios?)

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Inherited from

BaseAPI.constructor

Defined in

src/merkleAPI/swagger/base.ts:50

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/merkleAPI/swagger/base.ts:53

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/merkleAPI/swagger/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/merkleAPI/swagger/base.ts:48

Methods

v2AssetEventsGet

▸ v2AssetEventsGet(limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse2001, any>>

Gets all asset-related events for the specified user.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse2001, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1077

---

v2AssetGet

▸ v2AssetGet(tokenId, authorization, options?): Promise<AxiosResponse<InlineResponse2002, any>>

Gets details about the specified asset.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
tokenId	string
authorization	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse2002, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1095

---

v2CollectionActivityGet

▸ v2CollectionActivityGet(collectionId, limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse2001, any>>

Get all asset events related to the given collection.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
collectionId	string
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse2001, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1114

---

v2CollectionAssetsGet

▸ v2CollectionAssetsGet(fid, collectionId, limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse2005, any>>

Gets all assets owned by a given user for a specific collection.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
fid	number	-
collectionId	string
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse2005, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1141

---

v2CollectionGet

▸ v2CollectionGet(collectionId, authorization, options?): Promise<AxiosResponse<InlineResponse20010, any>>

Get details about a collection of assets.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
collectionId	string
authorization	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse20010, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1168

---

v2CollectionOwnersGet

▸ v2CollectionOwnersGet(collectionId, limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse2009, any>>

Get all users who own at least one asset from the specified collection.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
collectionId	string
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse2009, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1187

---

v2UserCollectionsGet

▸ v2UserCollectionsGet(fid, limit, authorization, cursor?, options?): Promise<AxiosResponse<InlineResponse20011, any>>

Get all collections owned by the specified user.

Throws

Memberof

AssetsApi

Parameters

Name	Type	Description
fid	number	-
limit	number
authorization	string
cursor?	string
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<InlineResponse20011, any>>

Defined in

src/merkleAPI/swagger/apis/assets-api.ts:1213