@reservoir0x/reservoir-sdk

import { Address, CustomTransport, HttpTransport, WalletClient, SimulateContractParameters, WriteContractParameters } from "viem"; import { AxiosRequestConfig, AxiosResponse } from "axios"; /** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/admin/get-marketplaces": { get: operations["getAdminGetmarketplaces"]; }; "/admin/open-api": { get: operations["getAdminOpenapi"]; }; "/admin/rate-limit-rules": { get: operations["getAdminRatelimitrules"]; }; "/assets/v1": { get: operations["getAssetsV1"]; }; "/attributes/v1": { get: operations["getAttributesV1"]; }; "/collection/v1": { /** Get detailed information about a single collection, including real-time stats. */ get: operations["getCollectionV1"]; }; "/collection/v2": { /** Get detailed information about a single collection, including real-time stats. */ get: operations["getCollectionV2"]; }; "/collection/v3": { /** Get detailed information about a single collection, including real-time stats. */ get: operations["getCollectionV3"]; }; "/collections/v1": { /** Useful for getting multiple collections to show in a marketplace, or search for particular collections. */ get: operations["getCollectionsV1"]; }; "/collections/v2": { /** Useful for getting multiple collections to show in a marketplace, or search for particular collections. */ get: operations["getCollectionsV2"]; }; "/collections/v3": { /** Useful for getting multiple collections to show in a marketplace, or search for particular collections. */ get: operations["getCollectionsV3"]; }; "/collections/v4": { /** Useful for getting multiple collections to show in a marketplace, or search for particular collections. */ get: operations["getCollectionsV4"]; }; "/collections/v5": { /** Use this API to explore a collection’s metadata and statistics (sales, volume, etc). */ get: operations["getCollectionsV5"]; }; "/collections/v6": { /** Use this API to explore a collection's metadata and statistics (sales, volume, etc). */ get: operations["getCollectionsV6"]; }; "/collections/v7": { /** Use this API to explore a collection's metadata and statistics (sales, volume, etc). */ get: operations["getCollectionsV7"]; }; "/cross-posting-orders/v1": { /** * This API can be used to check the status of cross posted listings and bids. * * Input your `crossPostingOrderId` into the `ids` param and submit for the status. * * The `crossPostingOrderId` is returned in the `execute/bids` and `execute/asks` response as well as the `onProgess` callback for the SDK. * * Note: ReservoirKit does not return a `crossPostingOrderId`. */ get: operations["getCrosspostingordersV1"]; }; "/fungibles/v1": { /** Get fungible data by contract address. */ get: operations["getFungiblesV1"]; }; "/orders/v1": { /** Access orders with various filters applied. If you need orders created by a single user, use the positions API instead. */ get: operations["getOrdersV1"]; post: operations["postOrdersV1"]; }; "/orders/v2": { /** Access orders with various filters applied. If you need orders created by a single user, use the positions API instead. */ get: operations["getOrdersV2"]; }; "/owners/v1": { /** Get owners with various filters applied, and a summary of their ownership. Useful for exploring top owners in a collection or attribute. */ get: operations["getOwnersV1"]; }; "/owners/v2": { /** Get owners with various filters applied, and a summary of their ownership. Useful for exploring top owners in a collection or attribute. */ get: operations["getOwnersV2"]; }; "/sales/v1": { /** Get recent sales for a contract or token. */ get: operations["getSalesV1"]; }; "/sales/v2": { /** Get recent sales for a contract or token. */ get: operations["getSalesV2"]; }; "/sales/v3": { /** Get recent sales for a contract or token. Note: this API is returns rich metadata, and has advanced filters, so is only designed for small amounts of recent sales. If you want access to sales in bulk, use the `Aggregator > Bulk Sales` API. */ get: operations["getSalesV3"]; }; "/sales/v4": { /** Get recent sales for a contract or token. */ get: operations["getSalesV4"]; }; "/sales/v5": { /** Get recent sales for a contract or token. Paid mints are returned in this `sales` endpoint, free mints can be found in the `/activities/` endpoints. Array of contracts max limit is 20. */ get: operations["getSalesV5"]; }; "/sales/v6": { /** Get recent sales for a contract or token. Paid mints are returned in this `sales` endpoint, free mints can be found in the `/activities/` endpoints. Array of contracts max limit is 20. */ get: operations["getSalesV6"]; }; "/sources/v1": { /** This API returns a list of sources */ get: operations["getSourcesV1"]; }; "/stats/v1": { /** Get aggregate stats for a particular set (collection, attribute or single token) */ get: operations["getStatsV1"]; }; "/stats/v2": { /** Get aggregate stats for a particular set (collection, attribute or single token) */ get: operations["getStatsV2"]; }; "/tokens/v1": { /** This API is optimized for quickly fetching a list of tokens in a collection, sorted by price, with only the most important information returned. If you need more metadata, use the `tokens/details` API */ get: operations["getTokensV1"]; }; "/tokens/v2": { /** This API is optimized for quickly fetching a list of tokens in a collection, sorted by price, with only the most important information returned. If you need more metadata, use the `tokens/details` API */ get: operations["getTokensV2"]; }; "/tokens/v3": { /** This API is optimized for quickly fetching a list of tokens in a collection, sorted by price, with only the most important information returned. If you need more metadata, use the `tokens/details` API */ get: operations["getTokensV3"]; }; "/tokens/v4": { /** This API is optimized for quickly fetching a list of tokens in a collection, sorted by price, with only the most important information returned. If you need more metadata, use the tokens/details API */ get: operations["getTokensV4"]; }; "/tokens/v5": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. */ get: operations["getTokensV5"]; }; "/tokens/v6": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. */ get: operations["getTokensV6"]; }; "/tokens/v7": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. */ get: operations["getTokensV7"]; }; "/transfers/v2": { /** Get recent transfers for a contract or token. */ get: operations["getTransfersV2"]; }; "/transfers/v3": { /** Get recent transfers for a contract or token. */ get: operations["getTransfersV3"]; }; "/transfers/v4": { /** Get recent transfers for a contract or token. */ get: operations["getTransfersV4"]; }; "/admin/get-api-key/{key}": { get: operations["getAdminGetapikeyKey"]; }; "/admin/provider-metadata/{type}": { get: operations["getAdminProvidermetadataType"]; }; "/api-keys/{key}/rate-limits": { /** Get the rate limits for the given API key. Note: API keys are not universal across all available chains; please make a different key for every chain. */ get: operations["getApikeysKeyRatelimits"]; }; "/chain/stats/v1": { /** Get chain mint and sales stats for 1 and 7 days */ get: operations["getChainStatsV1"]; }; "/collections/activity/v4": { /** This API can be used to build a feed for a collection */ get: operations["getCollectionsActivityV4"]; }; "/collections/activity/v5": { /** This API can be used to build a feed for a collection */ get: operations["getCollectionsActivityV5"]; }; "/collections/activity/v6": { /** This API can be used to build a feed for a collection including sales, asks, transfers, mints, bids, cancelled bids, and cancelled asks types. */ get: operations["getCollectionsActivityV6"]; }; "/collections/daily-volumes/v1": { /** Get date, volume, rank and sales count for each collection */ get: operations["getCollectionsDailyvolumesV1"]; }; "/collections/search/v1": { get: operations["getCollectionsSearchV1"]; }; "/collections/top-selling/v1": { /** Get top selling and minting collections */ get: operations["getCollectionsTopsellingV1"]; }; "/collections/top-selling/v2": { /** Get top selling and minting collections */ get: operations["getCollectionsTopsellingV2"]; }; "/collections/trending/v1": { /** Get trending selling/minting collections */ get: operations["getCollectionsTrendingV1"]; }; "/collections/trending-mints/v1": { /** Get top trending mints */ get: operations["getCollectionsTrendingmintsV1"]; }; "/collections/trending-mints/v2": { /** Get top trending mints */ get: operations["getCollectionsTrendingmintsV2"]; }; "/collections/{collectionOrSlug}/v1": { /** Get detailed information about a single collection, including real-time stats. */ get: operations["getCollectionsCollectionorslugV1"]; }; "/currencies/conversion/v1": { /** Convert an amount in one currency to another */ get: operations["getCurrenciesConversionV1"]; }; "/events/asks/v2": { /** Get updates any time an asks status changes */ get: operations["getEventsAsksV2"]; }; "/events/asks/v3": { /** * Every time an ask status changes, an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was canceled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Note: Private listings (asks) will not appear in the results. */ get: operations["getEventsAsksV3"]; }; "/events/bids/v1": { /** Get updates any time a bid status changes */ get: operations["getEventsBidsV1"]; }; "/events/bids/v2": { /** Get updates any time a bid status changes */ get: operations["getEventsBidsV2"]; }; "/events/bids/v3": { /** * Every time a bid status changes, an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new offer at a lower price * * - `expiry` > the previous best offer expired * * - `sale` > the previous best offer was filled * * - `cancel` > the previous best offer was canceled * * - `balance-change` > the best offer was invalidated due to no longer owning the NFT * * - `approval-change` > the best offer was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Selling a partial quantity of available 1155 tokens in a listing will generate a `sale` and will have a new quantity. * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. */ get: operations["getEventsBidsV3"]; }; "/events/orders/v1": { /** Get updates any time an order status changes */ get: operations["getEventsOrdersV1"]; }; "/execute/cancel/v2": { /** Cancel an existing order on any marketplace */ get: operations["getExecuteCancelV2"]; }; "/liquidity/users/v1": { /** This API calculates the total liquidity created by users, based on the number of tokens they are top bidder for. */ get: operations["getLiquidityUsersV1"]; }; "/liquidity/users/v2": { /** This API calculates the total liquidity created by users, based on the number of tokens they are top bidder for. */ get: operations["getLiquidityUsersV2"]; }; "/orders/all/v1": { /** This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersAllV1"]; }; "/orders/all/v2": { /** This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersAllV2"]; }; "/orders/asks/v1": { /** This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersAsksV1"]; }; "/orders/asks/v2": { /** Get a list of asks (listings), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersAsksV2"]; }; "/orders/asks/v3": { /** Get a list of asks (listings), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersAsksV3"]; }; "/orders/asks/v4": { /** * Get a list of asks (listings), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing. * * Please mark `excludeEOA` as `true` to exclude Blur orders. */ get: operations["getOrdersAsksV4"]; }; "/orders/asks/v5": { /** * Get a list of asks (listings), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing. * * To get all orders unflitered, select `sortBy` to `updatedAt`. No need to pass any other param. This will return any orders for any collections, token, attribute, etc. * * Please mark `excludeEOA` as `true` to exclude Blur orders. */ get: operations["getOrdersAsksV5"]; }; "/orders/bids/v1": { /** This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersBidsV1"]; }; "/orders/bids/v2": { /** Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersBidsV2"]; }; "/orders/bids/v3": { /** Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersBidsV3"]; }; "/orders/bids/v4": { /** Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing */ get: operations["getOrdersBidsV4"]; }; "/orders/bids/v5": { /** * Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing. * * There are a different kind of bids than can be returned: * * - Inputting a 'contract' will return token and attribute bids. * * - Inputting a 'collection-id' will return collection wide bids./n/n Please mark `excludeEOA` as `true` to exclude Blur orders. */ get: operations["getOrdersBidsV5"]; }; "/orders/bids/v6": { /** * Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing. * * There are a different kind of bids than can be returned: * * - To get all orders unfiltered, select `sortBy` to `updatedAt`. No need to pass any other param. This will return any orders for any collections, token, attribute, etc. * * - Inputting a 'contract' will return token and attribute bids. * * - Inputting a 'collection-id' will return collection wide bids. * * - Please mark `excludeEOA` as `true` to exclude Blur orders. */ get: operations["getOrdersBidsV6"]; }; "/orders/depth/v1": { /** Get the depth of a token or collection. */ get: operations["getOrdersDepthV1"]; }; "/orders/executed/v1": { get: operations["getOrdersExecutedV1"]; }; "/owners/common-collections/v1": { /** This API can be used to find top common collections from an array of owners. */ get: operations["getOwnersCommoncollectionsV1"]; }; "/owners/cross-collections/v1": { /** Find which addresses own the most of a group of collections. */ get: operations["getOwnersCrosscollectionsV1"]; }; "/pending-txs/tokens/v1": { /** Get tokens which have a pending sale transaction */ get: operations["getPendingtxsTokensV1"]; }; "/portfolio/activity/v1": { /** This API can be used to build a feed for a user including sales, asks, transfers, mints, bids, cancelled bids, and cancelled asks types. */ get: operations["getPortfolioActivityV1"]; }; "/portfolio/value/v1": { /** Get for the given wallet its portfolio value */ get: operations["getPortfolioValueV1"]; }; "/redirect/logo/v1": { get: operations["getRedirectLogoV1"]; }; "/redirect/token/v1": { get: operations["getRedirectTokenV1"]; }; "/sales/bulk/v1": { /** Note: this API is optimized for bulk access, and offers minimal filters/metadata. If you need more flexibility, try the `NFT API > Sales` endpoint */ get: operations["getSalesBulkV1"]; }; "/search/activities/v1": { /** This API can be used to build a feed for a collection including sales, asks, transfers, mints, bids, cancelled bids, and cancelled asks types. */ get: operations["getSearchActivitiesV1"]; }; "/search/collections/v1": { get: operations["getSearchCollectionsV1"]; }; "/search/collections/v2": { get: operations["getSearchCollectionsV2"]; }; "/search/collections/v3": { get: operations["getSearchCollectionsV3"]; }; "/sync/asks/v1": { /** This API is optimized for bulk access to asks (listings) for syncing a remote database. Thus it offers minimal filters/metadata. */ get: operations["getSyncAsksV1"]; }; "/tokens/bootstrap/v1": { /** Get the latest price event per token in a collection, so that you can listen to future events and keep track of prices */ get: operations["getTokensBootstrapV1"]; }; "/tokens/details/v2": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. If you don't need this metadata, you should use the <a href='#/tokens/getTokensV1'>tokens</a> API, which is much faster. */ get: operations["getTokensDetailsV2"]; }; "/tokens/details/v3": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. If you don't need this metadata, you should use the <a href='#/tokens/getTokensV1'>tokens</a> API, which is much faster. */ get: operations["getTokensDetailsV3"]; }; "/tokens/details/v4": { /** Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata. If you don't need this metadata, you should use the <a href='#/tokens/getTokensV1'>tokens</a> API, which is much faster. */ get: operations["getTokensDetailsV4"]; }; "/tokens/floor/v1": { /** This API will return the best price of every token in a collection that is currently on sale. Note: Prices are returned in the native currency of the network. */ get: operations["getTokensFloorV1"]; }; "/tokens/ids/v1": { /** This API is optimized for quickly fetching a list of tokens ids in by collection, contract, token set id. */ get: operations["getTokensIdsV1"]; }; "/tokens/prices/v1": { /** Get for the given token contract historic prices by day/hour */ get: operations["getTokensPricesV1"]; }; "/transactions/synced/v2": { /** Get a boolean response on whether a particular transaction was synced or not. */ get: operations["getTransactionsSyncedV2"]; }; "/transfers/bulk/v1": { /** Note: this API is optimized for bulk access, and offers minimal filters/metadata. If you need more flexibility, try the `NFT API > Transfers` endpoint */ get: operations["getTransfersBulkV1"]; }; "/transfers/bulk/v2": { /** Note: this API is optimized for bulk access, and offers minimal filters/metadata. If you need more flexibility, try the `NFT API > Transfers` endpoint */ get: operations["getTransfersBulkV2"]; }; "/users/activity/v2": { /** This API can be used to build a feed for a user */ get: operations["getUsersActivityV2"]; }; "/users/activity/v3": { /** This API can be used to build a feed for a user */ get: operations["getUsersActivityV3"]; }; "/users/activity/v4": { /** This API can be used to build a feed for a user */ get: operations["getUsersActivityV4"]; }; "/users/activity/v5": { /** This API can be used to build a feed for a user */ get: operations["getUsersActivityV5"]; }; "/users/activity/v6": { /** This API can be used to build a feed for a user including sales, asks, transfers, mints, bids, cancelled bids, and cancelled asks types. */ get: operations["getUsersActivityV6"]; }; "/collections/{collection}/marketplace-configurations/v1": { /** This API returns recommended marketplace configurations given a collection id */ get: operations["getCollectionsCollectionMarketplaceconfigurationsV1"]; }; "/collections/{collection}/top-traders/v1": { /** Get top traders for a particular collection */ get: operations["getCollectionsCollectionToptradersV1"]; }; "/collections/{collection}/top-bids/v1": { /** When users are placing collection or trait bids, this API can be used to show them where the bid is in the context of other bids, and how many tokens it will be the top bid for. */ get: operations["getCollectionsCollectionTopbidsV1"]; }; "/collections/{collection}/activity/v2": { /** This API can be used to build a feed for a collection */ get: operations["getCollectionsCollectionActivityV2"]; }; "/collections/{collection}/activity/v1": { /** This API can be used to build a feed for a collection */ get: operations["getCollectionsCollectionActivityV1"]; }; "/collections/{collection}/activity/v3": { /** This API can be used to build a feed for a collection */ get: operations["getCollectionsCollectionActivityV3"]; }; "/collections/{collection}/attributes/v1": { get: operations["getCollectionsCollectionAttributesV1"]; }; "/collections/{collection}/owners-distribution/v1": { /** This API can be used to show what the distribution of owners in a collection looks like. */ get: operations["getCollectionsCollectionOwnersdistributionV1"]; }; "/collections/{collection}/supported-marketplaces/v1": { /** The ReservoirKit `ListModal` client utilizes this API to identify the marketplace(s) it can list on. */ get: operations["getCollectionsCollectionSupportedmarketplacesV1"]; }; "/collections/{collection}/marketplace-configurations/v2": { /** This API returns recommended marketplace configurations given a collection id */ get: operations["getCollectionsCollectionMarketplaceconfigurationsV2"]; }; "/collections/{collectionId}/bids/v1": { /** Get a list of bids (offers), filtered by collection. */ get: operations["getCollectionsCollectionidBidsV1"]; }; "/collections-sets/{collectionsSetId}/owners-distribution/v1": { /** This API can be used to show what the distribution of owners in a collections set id looks like. */ get: operations["getCollectionssetsCollectionssetidOwnersdistributionV1"]; }; "/events/collections/floor-ask/v1": { /** * Every time the floor price of a collection changes (i.e. the 'floor ask'), an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was cancelled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the best price changes. So if a new order or sale happens without changing the best price, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsCollectionsFlooraskV1"]; }; "/events/collections/floor-ask/v2": { /** * Every time the floor price of a collection changes (i.e. the 'floor ask'), an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was cancelled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Selling a partial quantity of available 1155 tokens in a listing will generate a `sale` and will have a new quantity. * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the best price changes. So if a new order or sale happens without changing the best price, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsCollectionsFlooraskV2"]; }; "/events/collections/top-bid/v1": { /** Every time the top offer of a collection changes (i.e. the 'top bid'), an event is generated. This API is designed to be polled at high frequency. */ get: operations["getEventsCollectionsTopbidV1"]; }; "/events/collections/top-bid/v2": { /** * Every time the top offer of a collection changes (i.e. the 'top bid'), an event is generated. This API is designed to be polled at high frequency. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new bid at a higher price * * - `expiry` > the previous top bid expired * * - `sale` > the previous top bid was accepted * * - `cancel` > the previous top bid was cancelled * * - `balance-change` > the top bid was invalidated due NFT no longer available * * - `approval-change` > the top bid was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Selling a partial quantity of available 1155 tokens in a listing will generate a `sale` and will have a new quantity. * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the top bid changes. So if a new order or sale happens without changing the top bid, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsCollectionsTopbidV2"]; }; "/events/tokens/floor-ask/v2": { /** * Every time the best price of a token changes (i.e. the 'floor ask'), an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was cancelled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the best price changes. So if a new order or sale happens without changing the best price, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsTokensFlooraskV2"]; }; "/events/tokens/floor-ask/v3": { /** * Every time the best price of a token changes (i.e. the 'floor ask'), an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was cancelled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the best price changes. So if a new order or sale happens without changing the best price, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsTokensFlooraskV3"]; }; "/events/tokens/floor-ask/v4": { /** * Every time the best price of a token changes (i.e. the 'floor ask'), an event is generated. This API is designed to be polled at high frequency, in order to keep an external system in sync with accurate prices for any token. * * There are multiple event types, which describe what caused the change in price: * * - `new-order` > new listing at a lower price * * - `expiry` > the previous best listing expired * * - `sale` > the previous best listing was filled * * - `cancel` > the previous best listing was cancelled * * - `balance-change` > the best listing was invalidated due to no longer owning the NFT * * - `approval-change` > the best listing was invalidated due to revoked approval * * - `revalidation` > manual revalidation of orders (e.g. after a bug fixed) * * - `reprice` > price update for dynamic orders (e.g. dutch auctions) * * - `bootstrap` > initial loading of data, so that all tokens have a price associated * * Some considerations to keep in mind * * - Selling a partial quantity of available 1155 tokens in a listing will generate a `sale` and will have a new quantity. * * - Due to the complex nature of monitoring off-chain liquidity across multiple marketplaces, including dealing with block re-orgs, events should be considered 'relative' to the perspective of the indexer, ie _when they were discovered_, rather than _when they happened_. A more deterministic historical record of price changes is in development, but in the meantime, this method is sufficent for keeping an external system in sync with the best available prices. * * - Events are only generated if the best price changes. So if a new order or sale happens without changing the best price, no event is generated. This is more common with 1155 tokens, which have multiple owners and more depth. For this reason, if you need sales data, use the Sales API. */ get: operations["getEventsTokensFlooraskV4"]; }; "/oracle/collections/bid-ask-midpoint/v1": { /** Get a signed message of any collection's bid-ask midpoint (spot or twap). This is approximation of the colletion price. The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleCollectionsBidaskmidpointV1"]; }; "/oracle/collections/floor-ask/v4": { /** Get a signed message of any collection's floor price (spot or twap). The oracle's address is 0x32dA57E736E05f75aa4FaE2E9Be60FD904492726. */ get: operations["getOracleCollectionsFlooraskV4"]; }; "/oracle/collections/floor-ask/v5": { /** Get a signed message of any collection's floor price (spot or twap). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleCollectionsFlooraskV5"]; }; "/oracle/collections/floor-ask/v6": { /** Get a signed message of any collection's floor price (spot or twap). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleCollectionsFlooraskV6"]; }; "/oracle/collections/top-bid/v2": { /** Get a signed message of any collection's top bid price (spot or twap). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleCollectionsTopbidV2"]; }; "/oracle/collections/top-bid/v3": { /** Get a signed message of any collection's top bid price (spot or twap). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleCollectionsTopbidV3"]; }; "/oracle/tokens/status/v2": { /** Get a signed message of a token's details (flagged status and last transfer time). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleTokensStatusV2"]; }; "/oracle/tokens/status/v3": { /** Get a signed message of a token's details (flagged status and last transfer time). The oracle's address is 0xAeB1D03929bF87F69888f381e73FBf75753d75AF. The address is the same for all chains. */ get: operations["getOracleTokensStatusV3"]; }; "/portfolio/historical/value/v1": { /** Get for the given wallet its historical portfolio value */ get: operations["getPortfolioHistoricalValueV1"]; }; "/portfolio/nfts/balance/v1": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getPortfolioNftsBalanceV1"]; }; "/portfolio/tokens/balance/v1": { /** Get for the given wallet its tokens balance */ get: operations["getPortfolioTokensBalanceV1"]; }; "/tokens/flag/changes/v1": { /** This API return the recent flagged/un-flagged tokens across all collections sorted by change time */ get: operations["getTokensFlagChangesV1"]; }; "/tokens/{token}/bids/v1": { /** Get a list of bids (offers), filtered by token. */ get: operations["getTokensTokenBidsV1"]; }; "/tokens/{token}/activity/v4": { /** This API can be used to build a feed for a token */ get: operations["getTokensTokenActivityV4"]; }; "/tokens/{token}/activity/v2": { /** This API can be used to build a feed for a token */ get: operations["getTokensTokenActivityV2"]; }; "/tokens/{token}/activity/v1": { /** This API can be used to build a feed for a token */ get: operations["getTokensTokenActivityV1"]; }; "/tokens/{token}/activity/v3": { /** This API can be used to build a feed for a token */ get: operations["getTokensTokenActivityV3"]; }; "/tokens/{token}/activity/v5": { /** This API can be used to build a feed for a token activity including sales, asks, transfers, mints, bids, cancelled bids, and cancelled asks types. */ get: operations["getTokensTokenActivityV5"]; }; "/tokens/{token}/asks/v1": { /** Get a list of asks (listings), filtered by token. */ get: operations["getTokensTokenAsksV1"]; }; "/transactions/{txHash}/synced/v1": { /** Get a boolean response on whether a particular transaction was synced or not. */ get: operations["getTransactionsTxhashSyncedV1"]; }; "/users/{user}/tokens/v9": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV9"]; }; "/users/{user}/tokens/v7": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV7"]; }; "/users/{user}/tokens/v5": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV5"]; }; "/users/{user}/tokens/v3": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV3"]; }; "/users/{user}/tokens/v1": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV1"]; }; "/users/{user}/bids/v1": { /** Get a list of bids (offers), filtered by maker. */ get: operations["getUsersUserBidsV1"]; }; "/users/{user}/positions/v1": { /** Get aggregate user liquidity, grouped by collection. Useful for showing a summary of liquidity being provided (orders made). */ get: operations["getUsersUserPositionsV1"]; }; "/users/{user}/collections/v3": { /** Get aggregate stats for a user, grouped by collection. Useful for showing total portfolio information. */ get: operations["getUsersUserCollectionsV3"]; }; "/users/{user}/collections/v1": { /** Get aggregate stats for a user, grouped by collection. Useful for showing total portfolio information. */ get: operations["getUsersUserCollectionsV1"]; }; "/users/{user}/activity/v1": { /** This API can be used to build a feed for a user */ get: operations["getUsersUserActivityV1"]; }; "/users/{user}/collections/v2": { /** Get aggregate stats for a user, grouped by collection. Useful for showing total portfolio information. */ get: operations["getUsersUserCollectionsV2"]; }; "/users/{user}/collections/v4": { /** Get aggregate stats for a user, grouped by collection. Useful for showing total portfolio information. */ get: operations["getUsersUserCollectionsV4"]; }; "/users/{user}/asks/v1": { /** Get a list of asks (listings), filtered by maker. */ get: operations["getUsersUserAsksV1"]; }; "/users/{user}/tokens/v2": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV2"]; }; "/users/{user}/tokens/v4": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV4"]; }; "/users/{user}/tokens/v6": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV6"]; }; "/users/{user}/tokens/v8": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV8"]; }; "/users/{user}/tokens/v10": { /** Get tokens held by a user, along with ownership information such as associated orders and date acquired. */ get: operations["getUsersUserTokensV10"]; }; "/collections/{collection}/attributes/explore/v5": { /** * Use this API to see stats on a specific attribute within a collection. This endpoint will return `tokenCount`, `onSaleCount`, `sampleImages`, and `floorAskPrices` by default. * * - `floorAskPrices` will not be returned on attributes with more than 10k tokens. */ get: operations["getCollectionsCollectionAttributesExploreV5"]; }; "/collections/{collection}/attributes/explore/v3": { /** Get detailed aggregate about attributes in a collection, attribute floors */ get: operations["getCollectionsCollectionAttributesExploreV3"]; }; "/collections/{collection}/attributes/explore/v1": { get: operations["getCollectionsCollectionAttributesExploreV1"]; }; "/collections/{collection}/attributes/static/v1": { get: operations["getCollectionsCollectionAttributesStaticV1"]; }; "/collections/{collection}/attributes/all/v3": { get: operations["getCollectionsCollectionAttributesAllV3"]; }; "/collections/{collection}/attributes/all/v1": { get: operations["getCollectionsCollectionAttributesAllV1"]; }; "/collections/{collection}/attributes/all/v2": { get: operations["getCollectionsCollectionAttributesAllV2"]; };