Query Modules
Class: ListingsQueryModule
query/modules/listings.ListingsQueryModule
Module for querying listing data from The Graph
Table of contents
Methods
constructor
• new ListingsQueryModule(queryClient): ListingsQueryModule
Parameters
| Name | Type |
|---|---|
queryClient | QueryClient |
Returns
ListingsQueryModule
Methods
getAll
▸ getAll(first?, skip?): Promise<ListingsResponse>
Get all listings without any filters
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
first | number | 100 | Number of items to fetch (default: 100) |
skip | number | 0 | Number of items to skip (default: 0) |
Returns
Promise<ListingsResponse>
Response with listings and pagination info
getListings
▸ getListings(params?, filters?): Promise<ListingsResponse>
Get a list of listings based on filtering and pagination parameters
Parameters
| Name | Type | Description |
|---|---|---|
params | PaginationParams | Pagination parameters |
filters | ListingFilters | Filtering options |
Returns
Promise<ListingsResponse>
List of listings with pagination info
getListingById
▸ getListingById(id): Promise<null | ListingObject>
Get a single listing by its ID
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The listing ID (can be blockchain ID or graph entity ID) |
Returns
Promise<null | ListingObject>
The listing or null if not found
getListingsByLicensor
▸ getListingsByLicensor(licensorAddress, params?): Promise<ListingsResponse>
Get all listings from a specific licensor
Parameters
| Name | Type | Description |
|---|---|---|
licensorAddress | `0x${string}` | Licensor’s address |
params | PaginationParams | Pagination parameters |
Returns
Promise<ListingsResponse>
List of listings with pagination info
getActiveListings
▸ getActiveListings(params?): Promise<ListingsResponse>
Get all active listings
Parameters
| Name | Type | Description |
|---|---|---|
params | PaginationParams | Pagination parameters |
Returns
Promise<ListingsResponse>
List of active listings with pagination info