@standard-crypto/farcaster-js / Modules / index / AssetsApi
index.AssetsApi
AssetsApi - object-oriented interface
Export
-
↳
AssetsApi
- v2AssetEventsGet
- v2AssetGet
- v2CollectionActivityGet
- v2CollectionAssetsGet
- v2CollectionGet
- v2CollectionOwnersGet
- v2UserCollectionsGet
• new AssetsApi(configuration?
, basePath?
, axios?
)
Name | Type | Default value |
---|---|---|
configuration? |
Configuration |
undefined |
basePath |
string |
BASE_PATH |
axios |
AxiosInstance |
globalAxios |
src/merkleAPI/swagger/base.ts:50
• Protected
axios: AxiosInstance
= globalAxios
src/merkleAPI/swagger/base.ts:53
• Protected
basePath: string
= BASE_PATH
src/merkleAPI/swagger/base.ts:52
• Protected
configuration: undefined
| Configuration
src/merkleAPI/swagger/base.ts:48
▸ v2AssetEventsGet(limit
, authorization
, cursor?
, options?
): Promise
<AxiosResponse
<InlineResponse2001
, any
>>
Gets all asset-related events for the specified user.
Throws
Memberof
AssetsApi
Name | Type | Description |
---|---|---|
limit |
number |
|
authorization |
string |
|
cursor? |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse2001
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1077
▸ v2AssetGet(tokenId
, authorization
, options?
): Promise
<AxiosResponse
<InlineResponse2002
, any
>>
Gets details about the specified asset.
Throws
Memberof
AssetsApi
Name | Type | Description |
---|---|---|
tokenId |
string |
|
authorization |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse2002
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1095
▸ v2CollectionActivityGet(collectionId
, limit
, authorization
, cursor?
, options?
): Promise
<AxiosResponse
<InlineResponse2001
, any
>>
Get all asset events related to the given collection.
Throws
Memberof
AssetsApi
Name | Type | Description |
---|---|---|
collectionId |
string |
|
limit |
number |
|
authorization |
string |
|
cursor? |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse2001
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1114
▸ 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
Name | Type | Description |
---|---|---|
fid |
number |
- |
collectionId |
string |
|
limit |
number |
|
authorization |
string |
|
cursor? |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse2005
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1141
▸ v2CollectionGet(collectionId
, authorization
, options?
): Promise
<AxiosResponse
<InlineResponse20010
, any
>>
Get details about a collection of assets.
Throws
Memberof
AssetsApi
Name | Type | Description |
---|---|---|
collectionId |
string |
|
authorization |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse20010
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1168
▸ 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
Name | Type | Description |
---|---|---|
collectionId |
string |
|
limit |
number |
|
authorization |
string |
|
cursor? |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse2009
, any
>>
src/merkleAPI/swagger/apis/assets-api.ts:1187
▸ v2UserCollectionsGet(fid
, limit
, authorization
, cursor?
, options?
): Promise
<AxiosResponse
<InlineResponse20011
, any
>>
Get all collections owned by the specified user.
Throws
Memberof
AssetsApi
Name | Type | Description |
---|---|---|
fid |
number |
- |
limit |
number |
|
authorization |
string |
|
cursor? |
string |
|
options? |
AxiosRequestConfig <any > |
Override http request option. |
Promise
<AxiosResponse
<InlineResponse20011
, any
>>