@reservoir0x/reservoir-kit-client
Version:
ReservoirKit is the official frontend kit to get you started building dApps with the ReservoirProtocol.
1,303 lines • 298 kB
TypeScript
import { AxiosRequestConfig, AxiosResponse } from "axios";
import { Signer } from "ethers";
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/activity/v1": {
/** This API can be used to scrape all of the activities */
get: operations["getActivityV1"];
};
"/activity/v2": {
/** This API can be used to scrape all of the activities */
get: operations["getActivityV2"];
};
"/activity/v3": {
/** This API can be used to scrape all of the activities */
get: operations["getActivityV3"];
};
"/activity/v4": {
/** This API can be used to scrape all of the activities */
get: operations["getActivityV4"];
};
"/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": {
/** Useful for getting multiple collections to show in a marketplace, or search for particular collections. */
get: operations["getCollectionsV5"];
};
"/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"];
};
"/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"];
};
"/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"];
};
"/transfers/v2": {
/** Get recent transfers for a contract or token. */
get: operations["getTransfersV2"];
};
"/api-keys/{key}/rate-limits": {
/** Get the rate limits for the given API key */
get: operations["getApikeysKeyRatelimits"];
};
"/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/daily-volumes/v1": {
/** Get date, volume, rank and sales count for each collection */
get: operations["getCollectionsDailyvolumesV1"];
};
"/collections/sources/v1": {
/** This API returns aggregated listings info for the given collection per source */
get: operations["getCollectionsSourcesV1"];
};
"/collections/{collectionOrSlug}/v1": {
/** Get detailed information about a single collection, including real-time stats. */
get: operations["getCollectionsCollectionorslugV1"];
};
"/events/asks/v2": {
/** Get updates any time an asks status changes */
get: operations["getEventsAsksV2"];
};
"/events/asks/v3": {
/** Get updates any time an asks status changes */
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/orders/v1": {
/** Get updates any time an order status changes */
get: operations["getEventsOrdersV1"];
};
"/execute/bid/v2": {
/** Generate a bid and submit it to multiple marketplaces */
get: operations["getExecuteBidV2"];
};
"/execute/buy/v1": {
get: operations["getExecuteBuyV1"];
};
"/execute/buy/v2": {
get: operations["getExecuteBuyV2"];
};
"/execute/buy/v3": {
get: operations["getExecuteBuyV3"];
};
"/execute/cancel/v1": {
/** Cancel an existing order on any marketplace */
get: operations["getExecuteCancelV1"];
};
"/execute/cancel/v2": {
/** Cancel an existing order on any marketplace */
get: operations["getExecuteCancelV2"];
};
"/execute/list/v2": {
/** Generate a listing and submit it to multiple marketplaces */
get: operations["getExecuteListV2"];
};
"/execute/sell/v1": {
get: operations["getExecuteSellV1"];
};
"/execute/sell/v2": {
get: operations["getExecuteSellV2"];
};
"/execute/sell/v3": {
get: operations["getExecuteSellV3"];
};
"/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 */
get: operations["getOrdersAsksV4"];
};
"/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 */
get: operations["getOrdersBidsV5"];
};
"/orders/executed/v1": {
get: operations["getOrdersExecutedV1"];
};
"/owners/common-collections/v1": {
/** This API can be used to find top common collections among the given owners */
get: operations["getOwnersCommoncollectionsV1"];
};
"/owners/cross-collections/v1": {
/** Find which addresses own the most of a group of collections. */
get: operations["getOwnersCrosscollectionsV1"];
};
"/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/collections/v1": {
get: operations["getSearchCollectionsV1"];
};
"/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 */
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"];
};
"/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"];
};
"/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"];
};
"/collections/{collection}/attributes/v1": {
get: operations["getCollectionsCollectionAttributesV1"];
};
"/collections/{collection}/activity/v3": {
/** This API can be used to build a feed for a collection */
get: operations["getCollectionsCollectionActivityV3"];
};
"/collections/{collection}/activity/v1": {
/** This API can be used to build a feed for a collection */
get: operations["getCollectionsCollectionActivityV1"];
};
"/collections/{collection}/activity/v2": {
/** This API can be used to build a feed for a collection */
get: operations["getCollectionsCollectionActivityV2"];
};
"/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}/owners-distribution/v1": {
/** This API can be used to show what the distribution of owners in a collection looks like. */
get: operations["getCollectionsCollectionOwnersdistributionV1"];
};
"/collections-sets/{collectionsSetId}/owners-distribution/v1": {
/** This API can be used to show what the distribution of owners in a collections set 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/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/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"];
};
"/oracle/collections/floor-ask/v4": {
/** Get a signed message of any collection's floor price (spot or twap). The oracle signer address is 0x32da57e736e05f75aa4fae2e9be60fd904492726. */
get: operations["getOracleCollectionsFlooraskV4"];
};
"/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}/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"];
};
"/transactions/{txHash}/synced/v1": {
/** Get a boolean response on whether a particular transaction was synced or not. */
get: operations["getTransactionsTxhashSyncedV1"];
};
"/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}/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/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}/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"];
};
"/collections/{collection}/attributes/explore/v4": {
/** Get detailed aggregate about attributes in a collection, attribute floors */
get: operations["getCollectionsCollectionAttributesExploreV4"];
};
"/collections/{collection}/attributes/explore/v2": {
/** Get detailed aggregate about attributes in a collection, attribute floors */
get: operations["getCollectionsCollectionAttributesExploreV2"];
};
"/collections/{collection}/attributes/all/v2": {
get: operations["getCollectionsCollectionAttributesAllV2"];
};
"/collections/{collection}/attributes/all/v1": {
get: operations["getCollectionsCollectionAttributesAllV1"];
};
"/collections/{collection}/attributes/static/v1": {
get: operations["getCollectionsCollectionAttributesStaticV1"];
};
"/collections/{collection}/attributes/explore/v1": {
get: operations["getCollectionsCollectionAttributesExploreV1"];
};
"/collections/{collection}/attributes/explore/v3": {
/** Get detailed aggregate about attributes in a collection, attribute floors */
get: operations["getCollectionsCollectionAttributesExploreV3"];
};
"/oracle/collections/{collection}/floor-ask/v3": {
/** Get a signed message of any collection's floor price (spot or twap). The oracle signer address is 0x32da57e736e05f75aa4fae2e9be60fd904492726. */
get: operations["getOracleCollectionsCollectionFlooraskV3"];
};
"/oracle/collections/{collection}/floor-ask/v1": {
/** Get a signed message of any collection's floor price (spot or twap). The oracle signer address is 0x32da57e736e05f75aa4fae2e9be60fd904492726. */
get: operations["getOracleCollectionsCollectionFlooraskV1"];
};
"/oracle/collections/{collection}/floor-ask/v2": {
/** Get a signed message of any collection's floor price (spot or twap). The oracle signer address is 0x32da57e736e05f75aa4fae2e9be60fd904492726. */
get: operations["getOracleCollectionsCollectionFlooraskV2"];
};
"/orders/users/{user}/top-bids/v2": {
/** Return the top bids for the given user tokens */
get: operations["getOrdersUsersUserTopbidsV2"];
};
"/orders/users/{user}/top-bids/v1": {
/** Return the top bids for the given user tokens */
get: operations["getOrdersUsersUserTopbidsV1"];
};
"/redirect/collections/{collection}/image/v1": {
get: operations["getRedirectCollectionsCollectionImageV1"];
};
"/redirect/currency/{address}/icon/v1": {
get: operations["getRedirectCurrencyAddressIconV1"];
};
"/redirect/sources/{source}/logo/v2": {
get: operations["getRedirectSourcesSourceLogoV2"];
};
"/redirect/tokens/{token}/image/v1": {
get: operations["getRedirectTokensTokenImageV1"];
};
"/redirect/sources/{source}/tokens/{token}/link/v2": {
get: operations["getRedirectSourcesSourceTokensTokenLinkV2"];
};
"/collections/{collection}/community/v1": {
put: operations["putCollectionsCollectionCommunityV1"];
};
"/api-keys": {
/**
* The API key can be used in every route, by setting it as a request header **x-api-key**.
*
* <a href='https://docs.reservoir.tools/reference/getting-started'>Learn more</a> about API Keys and Rate Limiting
*/
post: operations["postApikeys"];
};
"/admin/calc-rarity": {
post: operations["postAdminCalcrarity"];
};
"/admin/create-rate-limit-rule": {
post: operations["postAdminCreateratelimitrule"];
};
"/admin/delete-rate-limit-rule": {
post: operations["postAdminDeleteratelimitrule"];
};
"/admin/fix-blocks": {
post: operations["postAdminFixblocks"];
};
"/admin/fix-cache": {
post: operations["postAdminFixcache"];
};
"/admin/fix-orders": {
post: operations["postAdminFixorders"];
};
"/admin/fix-token-cache": {
post: operations["postAdminFixtokencache"];
};
"/admin/flag-address": {
post: operations["postAdminFlagaddress"];
};
"/admin/index-metadata": {
post: operations["postAdminIndexmetadata"];
};
"/admin/invalidate-order": {
post: operations["postAdminInvalidateorder"];
};
"/admin/refresh-collection": {
post: operations["postAdminRefreshcollection"];
};
"/admin/refresh-collection-flags": {
post: operations["postAdminRefreshcollectionflags"];
};
"/admin/refresh-token": {
post: operations["postAdminRefreshtoken"];
};
"/admin/resync-floor-events": {
post: operations["postAdminResyncfloorevents"];
};
"/admin/resync-source": {
post: operations["postAdminResyncsource"];
};
"/admin/set-community": {
post: operations["postAdminSetcommunity"];
};
"/admin/sync-arweave": {
post: operations["postAdminSyncarweave"];
};
"/admin/sync-daily-volumes": {
post: operations["postAdminSyncdailyvolumes"];
};
"/admin/sync-events": {
post: operations["postAdminSyncevents"];
};
"/admin/update-api-key": {
post: operations["postAdminUpdateapikey"];
};
"/admin/update-rate-limit-rule": {
post: operations["postAdminUpdateratelimitrule"];
};
"/admin/update-source": {
post: operations["postAdminUpdatesource"];
};
"/collections-sets/v1": {
post: operations["postCollectionssetsV1"];
};
"/order/v2": {
post: operations["postOrderV2"];
};
"/order/v3": {
post: operations["postOrderV3"];
};
"/seaport/offers": {
post: operations["postSeaportOffers"];
};
"/token-sets/v1": {
post: operations["postTokensetsV1"];
};
"/collections/refresh/v1": {
post: operations["postCollectionsRefreshV1"];
};
"/execute/bid/v3": {
/** Generate a bid and submit it to multiple marketplaces */
post: operations["postExecuteBidV3"];
};
"/execute/bid/v4": {
/** Generate a bid and submit it to multiple marketplaces */
post: operations["postExecuteBidV4"];
};
"/execute/buy/v4": {
post: operations["postExecuteBuyV4"];
};
"/execute/buy/v5": {
post: operations["postExecuteBuyV5"];
};
"/execute/buy/v6": {
post: operations["postExecuteBuyV6"];
};
"/execute/list/v3": {
/** Generate a listing and submit it to multiple marketplaces */
post: operations["postExecuteListV3"];
};
"/execute/list/v4": {
/** Generate a listing and submit it to multiple marketplaces */
post: operations["postExecuteListV4"];
};
"/execute/sell/v4": {
post: operations["postExecuteSellV4"];
};
"/execute/sell/v5": {
post: operations["postExecuteSellV5"];
};
"/execute/sell/v6": {
post: operations["postExecuteSellV6"];
};
"/tokens/flag/v1": {
post: operations["postTokensFlagV1"];
};
"/tokens/refresh/v1": {
post: operations["postTokensRefreshV1"];
};
"/tokens/simulate-floor/v1": {
post: operations["postTokensSimulatefloorV1"];
};
"/tokens/simulate-top-bid/v1": {
post: operations["postTokensSimulatetopbidV1"];
};
}
export interface definitions {
source: {
[key: string]: unknown;
};
/** @description Amount of items returned in response. */
Model1: {
id?: number;
type?: string;
contract?: string;
collectionId?: string;
tokenId?: string;
fromAddress?: string;
toAddress?: string;
price?: number;
amount?: number;
timestamp?: number;
txHash?: string;
logIndex?: number;
batchIndex?: number;
source?: definitions["source"];
};
activities: definitions["Model1"][];
getActivityV1Response: {
/** @description Use continuation token to request next offset of items. */
continuation?: number;
activities?: definitions["activities"];
};
order: {
id?: string;
/** @enum {string} */
side?: "ask" | "bid";
source?: definitions["source"];
};
/** @description Amount of items returned in response. */
Model2: {
id?: number;
type?: string;
contract?: string;
collectionId?: string;
tokenId?: string;
fromAddress?: string;
toAddress?: string;
price?: number;
amount?: number;
timestamp?: number;
txHash?: string;
logIndex?: number;
batchIndex?: number;
order?: definitions["order"];
};
Model3: definitions["Model2"][];
getActivityV2Response: {
/** @description Use continuation token to request next offset of items. */
continuation?: number;
activities?: definitions["Model3"];
};
data: {
collectionId?: string;
collectionName?: string;
tokenName?: string;
image?: string;
};
Model4: {
/** @enum {string} */
kind?: "token";
data?: definitions["data"];
};
Model5: {
id?: string;
/** @enum {string} */
side?: "ask" | "bid";
source?: definitions["source"];
metadata?: definitions["Model4"];
};
/** @description Amount of items returned in response. */
Model6: {
id?: number;
type?: string;
contract?: string;
collectionId?: string;
tokenId?: string;
fromAddress?: string;
toAddress?: string;
price?: number;
amount?: number;
timestamp?: number;
txHash?: string;
logIndex?: number;
batchIndex?: number;
order?: definitions["Model5"];
};
Model7: definitions["Model6"][];
getActivityV3Response: {
continuation?: string;
activities?: definitions["Model7"];
};
token: {
tokenId?: string;
name?: string;
image?: string;
};
collection: {
id?: string;
name?: string;
image?: string;
};
Model8: {
token?: definitions["token"];
collection?: definitions["collection"];
};
Model9: {
/** @enum {string} */
kind?: "token";
data?: definitions["Model8"];
};
Model10: {
id?: string;
/** @enum {string} */
side?: "ask" | "bid";
source?: definitions["source"];
criteria?: definitions["Model9"];
};
/** @description Amount of items returned in response. */
Model11: {
id?: number;
type?: string;
contract?: string;
collectionId?: string;
tokenId?: string;
fromAddress?: string;
toAddress?: string;
price?: number;
amount?: number;
timestamp?: number;
txHash?: string;
logIndex?: number;
batchIndex?: number;
order?: definitions["Model10"];
};
Model12: definitions["Model11"][];
getActivityV4Response: {
continuation?: string;
activities?: definitions["Model12"];
};
fee: {
bps?: number;
percent?: number;
};
Model13: {
name?: string;
imageUrl?: string;
fee?: definitions["fee"];
feeBps?: number;
orderbook?: string;
orderKind?: string;
listingEnabled?: boolean;
};
marketplaces: definitions["Model13"][];
getMarketplacesv1Resp: {
marketplaces?: definitions["marketplaces"];
};
Model14: {
value: string;
count?: number;
};
values: definitions["Model14"][];
Model15: {
key: string;
/** @enum {string} */
kind: "string" | "number" | "date" | "range";
values?: definitions["values"];
};
attributes: definitions["Model15"][];
getAttributesV1Response: {
attributes?: definitions["attributes"];
};
sampleImages: string[];
royalties: {
recipient?: string;
bps?: number;
};
lastBuy: {
value?: number;
timestamp?: number;
};
Model16: {
contract?: string;
tokenId?: string;
name?: string;
image?: string;
};
floorAsk: {
id?: string;
price?: number;
maker?: string;
validFrom?: number;
validUntil?: number;
token?: definitions["Model16"];
};
topBid: {
id?: string;
value?: number;
maker?: string;
validFrom?: number;
validUntil?: number;
};
rank: {
"1day"?: number;
"7day"?: number;
"30day"?: number;
allTime?: number;
};
volumeChange: {
"1day"?: number;
"7day"?: number;
"30day"?: number;
};
Model17: {
id?: string;
slug?: string;
name?: string;
metadata?: definitions["source"];
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
onSaleCount?: string;
primaryContract?: string;
tokenSetId?: string;
royalties?: definitions["royalties"];
lastBuy?: definitions["lastBuy"];
lastSell?: definitions["lastBuy"];
floorAsk?: definitions["floorAsk"];
topBid?: definitions["topBid"];
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
floorSaleChange?: definitions["volumeChange"];
};
getCollectionV1Response: {
collection?: definitions["Model17"];
};
Model18: {
key?: string;
kind?: string;
count?: number;
};
Model19: definitions["Model18"][];
Model20: {
id?: string;
/** @description Open Sea slug */
slug?: string;
name?: string;
metadata?: definitions["source"];
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
onSaleCount?: string;
primaryContract?: string;
tokenSetId?: string;
royalties?: definitions["royalties"];
lastBuy?: definitions["lastBuy"];
floorAsk?: definitions["floorAsk"];
topBid?: definitions["topBid"];
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
floorSaleChange?: definitions["volumeChange"];
collectionBidSupported?: boolean;
ownerCount?: number;
attributes?: definitions["Model19"];
};
getCollectionV2Response: {
collection?: definitions["Model20"];
};
Model21: {
id?: string;
sourceDomain?: string;
price?: number;
maker?: string;
validFrom?: number;
validUntil?: number;
token?: definitions["Model16"];
};
Model22: {
id?: string;
/** @description Open Sea slug */
slug?: string;
name?: string;
metadata?: definitions["source"];
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
onSaleCount?: string;
primaryContract?: string;
tokenSetId?: string;
royalties?: definitions["royalties"];
lastBuy?: definitions["lastBuy"];
floorAsk?: definitions["Model21"];
topBid?: definitions["topBid"];
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
floorSaleChange?: definitions["volumeChange"];
collectionBidSupported?: boolean;
ownerCount?: number;
attributes?: definitions["Model19"];
};
getCollectionV3Response: {
collection?: definitions["Model22"];
};
Model23: {
id?: string;
slug?: string;
name?: string;
metadata?: definitions["source"];
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
tokenSetId?: string;
royalties?: definitions["royalties"];
floorAskPrice?: number;
topBidValue?: number;
topBidMaker?: string;
rank?: definitions["rank"];
volume?: definitions["rank"];
};
collections: definitions["Model23"][];
getCollectionsV1Response: {
collections?: definitions["collections"];
};
Model24: {
id?: string;
slug?: string;
name?: string;
image?: string;
banner?: string;
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
tokenSetId?: string;
primaryContract?: string;
floorAskPrice?: number;
topBidValue?: number;
topBidMaker?: string;
"1dayVolume"?: number;
"7dayVolume"?: number;
"30dayVolume"?: number;
allTimeVolume?: number;
allTimeRank?: number;
};
Model25: definitions["Model24"][];
getCollectionsV2Response: {
collections?: definitions["Model25"];
};
Model26: {
id?: string;
slug?: string;
name?: string;
image?: string;
banner?: string;
discordUrl?: string;
externalUrl?: string;
twitterUsername?: string;
description?: string;
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
tokenSetId?: string;
primaryContract?: string;
floorAskPrice?: number;
topBidValue?: number;
topBidMaker?: string;
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
};
Model27: definitions["Model26"][];
getCollectionsV3Response: {
collections?: definitions["Model27"];
};
Model28: {
id?: string;
slug?: string;
name?: string;
image?: string;
banner?: string;
discordUrl?: string;
externalUrl?: string;
twitterUsername?: string;
description?: string;
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
tokenSetId?: string;
primaryContract?: string;
floorAskPrice?: number;
topBidValue?: number;
topBidMaker?: string;
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
floorSaleChange?: definitions["volumeChange"];
};
Model29: definitions["Model28"][];
getCollectionsV4Response: {
continuation?: string;
collections?: definitions["Model29"];
};
currency: {
contract?: string;
name?: string;
symbol?: string;
decimals?: number;
};
amount: {
raw?: string;
decimal?: number;
usd?: number;
native?: number;
};
price: {
currency?: definitions["currency"];
amount?: definitions["amount"];
netAmount?: definitions["amount"];
};
Model30: {
id?: string;
sourceDomain?: string;
price?: definitions["price"];
maker?: string;
validFrom?: number;
validUntil?: number;
token?: definitions["Model16"];
};
Model31: {
id?: string;
sourceDomain?: string;
price?: definitions["price"];
maker?: string;
validFrom?: number;
validUntil?: number;
};
Model32: {
id?: string;
/** @description Open Sea slug */
slug?: string;
createdAt?: string;
name?: string;
image?: string;
banner?: string;
discordUrl?: string;
externalUrl?: string;
twitterUsername?: string;
openseaVerificationStatus?: string;
description?: string;
sampleImages?: definitions["sampleImages"];
tokenCount?: string;
onSaleCount?: string;
primaryContract?: string;
tokenSetId?: string;
royalties?: definitions["royalties"];
lastBuy?: definitions["lastBuy"];
floorAsk?: definitions["Model30"];
topBid?: definitions["Model31"];
rank?: definitions["rank"];
volume?: definitions["rank"];
volumeChange?: definitions["volumeChange"];
floorSale?: definitions["volumeChange"];
floorSaleChange?: definitions["volumeChange"];
salesCount?: definitions["rank"];
collectionBidSupported?: boolean;
ownerCount?: number;
attributes?: definitions["Model19"];
};
Model33: definitions["Model32"][];
getCollectionsV5Response: {
continuation?: string;
collections?: definitions["Model33"];
};
Model34: {
kind?: string;
recipient?: string;
bps?: number;
};
feeBreakdown: definitions["Model34"][];
Model35: {
id: string;
kind: string;
/** @enum {string} */
side: "buy" | "sell";
fillabilityStatus: string;
approvalStatus: string;
tokenSetId: string;
tokenSetSchemaHash: string;
maker: string;
taker: string;
price: number;
value: number;
validFrom: number;
validUntil: number;
sourceId?: string;
feeBps?: number;
feeBreakdown?: definitions["feeBreakdown"];
expiration: number;
createdAt: string;
updatedAt: string;
rawData?: definitions["source"];
};
orders: definitions["Model35"][];
getOrdersV1Response: {
orders?: definitions["orders"];
};
Model36: {
id: string;
kind: string;
/** @enum {string} */
side: "buy" | "sell";
fillabilityStatus: string;
approvalStatus: string;
tokenSetId: string;
tokenSetSchemaHash: string;
maker: string;
taker: string;
price: number;
value: number;
validFrom: number;
validUntil: number;
source?: string;
feeBps?: number;
feeBreakdown?: definitions["feeBreakdown"];
expiration: number;
createdAt: string;
updatedAt: string;
rawData?: definitions["source"];
};
Model37: definitions["Model36"][];
getOrdersV2Response: {
orders?: definitions["Model37"];
};
ownership: {
tokenCount?: string;
onSaleCount?: string;
floorAskPrice?: number;
topBidValue?: number;
totalBidValue?: number;
};
Model38: {
address?: string;
ownership?: definitions["ownership"];
};
owners: definitions["Model38"][];
getOwnersV1Response: {
owners?: definitions["owners"];
};
Model39: {
id?: string;
name?: string;
};
Model40: {
contract?: string;
tokenId?: string;
name?: string;
image?: string;
collection?: definitions["Model39"];
};
Model41: {
token?: definitions["Model40"];
maker?: string;
taker?: string;
amount?: string;
txHash?: string;
timestamp?: number;
price?: number;
};
sales: definitions["Model41"][];
getSalesV1Response: {
sales?: definitions["sales"];
};
Model42: {
token?: definitions