Jump to Content
Reference Docs
Dashboard
Log In
Reference Docs
Dashboard
Log In
Reference Docs
Typescript API Typings
All
Pages
Start typing to search…
JUMP TO
Introduction
What is Reservoir NFT?
Getting Started
Supported Chains
Ethereum NFT API
Polygon NFT API
Base NFT API
Abstract NFT API
ApeChain NFT API
Arbitrum NFT API
Arbitrum Nova API
Avalanche NFT API
B3 NFT API
Blast NFT API
Binance Smart Chain (BSC) NFT API
Cyber NFT API
Degen NFT API
Flow NFT API
Forma NFT API
Hychain NFT API
Linea NFT API
Nebula NFT API
Optimism NFT API
Polygon zkEVM NFT API
Redstone NFT API
Scroll NFT API
Sei NFT API
Shape NFT API
Soneium NFT API
Xai NFT API
Zero NFT API
zkSync Era NFT API
Zora NFT API
Supported Marketplaces
Usage Credits
TOOLS
Getting Started
Reservoir API Overview
Reservoir SDK (Typescript)
Typescript API Typings
Adapters
buyToken
mintToken
listToken
placeBid
acceptOffer
cancelOrder
transferTokens
ReservoirKit (React)
Installing ReservoirKit
Hooks
Theming
Troubleshooting
BuyModal
ListModal
BidModal
AcceptBidModal
CartPopover
CancelListingModal
CancelBidModal
EditListingModal
EditBidModal
CollectModal (Mint + Sweep)
MintModal
SweepModal
TokenMedia
CollectButton
Websockets
Asks (Listings)
Bids (Offers)
Sales
Transfers
Tokens
Token Attribute
Collections
Pending Transactions [Enterprise]
Approvals
top-bid.changed
Websocket best practices
NFT TRADING APIS
NFT Trading Overview
Create Bids
post
Buy Tokens
post
Cancel Orders
post
Create Listings
post
Mint Tokens
post
Sell Tokens
post
Transfer Tokens
post
Manage Orders
Check Cross Posting Status
get
Check Transaction Status
get
Submit Signed Orders
post
Check Transaction Status
get
NFT Data APIS
NFT Data Overview
Tokens
Tokens
get
Token Events Bootstrap
get
Token Prices
get
Attributes
Explore attributes
get
All attributes
get
Token IDs
get
Flagged Tokens
get
Token Asks (listings)
get
Token Bids (offers)
get
Create token set
post
Refresh Token
post
Collections
Collections
get
Search Collections (Cross Chain)
get
Top Trending Collections
get
Top Trending Mints
get
Collection Bids (offers)
get
Marketplace configurations by collection
get
Top Traders
get
Create collection set
post
Create contracts set
post
Refresh Collection
post
Top Trending Mints
get
Search Collections
get
Activity
Collection activity
get
Users activity
get
Token activity
get
Sales
Sales
get
Transfers
Bulk historical transfers
get
Historical token transfers
get
Orders
Asks (listings)
get
Bids (offers)
get
Orders depth
get
Stats
Stats
get
Daily collection volume
get
Chain
Chain Stats
get
Accounts
User Tokens
get
User Asks (listings)
get
User collections
get
User Bids (offers)
get
User Top Bids
get
Owners
Owners
get
Common Collections
get
Owners intersection
get
Owners Collection Distribution
get
Owners Collection Set Distribution
get
Additional APIs
Events
Collection floor changes
get
Collection top bid changes
get
Token price changes
get
Asks status changes
get
Bid status changes
get
Sources
Sources List
get
Management
Get rate limits for the given API key
get
Disable or reenable metadata for a collection
post
Update collections nsfw status
post
Update collections spam status
post
Create or update an external cosigner
post
Invalidate stale orders
post
Disable or reenable metadata for a token
post
Update token flag status
post
Update the tokens nsfw status
post
Update the tokens spam status
post
Override collections
post
Override collections
post
Simulate any given mint
post
Simulate any given order
post
Override tokens
post
Redirects
Redirect to the given collection image
get
Redirect response to the given currency address icon
get
Redirect response to the given source logo
get
Redirect response to the given token image
get
Redirect response to the given source token page
get
Misc
Attach a signature to an existing auth challenge
post
Off-chain cancel orders
post
Deposit funds to the solver
post
Attach a signature to an existing permit
post
Attach a signature to an existing pre-signature
post
Send the success status of an execution
post
Indirectly fill an order via a solver
post
Get the status of an execution
post
Get the capacity for indirect filling via a solver
post
Make arbitrary same-chain and cross-chain calls via solver
post
Get the capacity for indirect filling via a solver
post
Powered by
Typescript API Typings
Typescript API Typings Typescript Types that facilitate API interaction
