# Documentation

## Docs

- [Get a single activity by ID](https://docs.immutable.com/api-reference/activities/get-a-single-activity-by-id.md): Get a single activity by ID
- [List all activities](https://docs.immutable.com/api-reference/activities/list-all-activities.md): List all activities
- [List history of activities](https://docs.immutable.com/api-reference/activities/list-history-of-activities.md): List activities sorted by updated_at timestamp ascending, useful for time based data replication
- [List supported chains](https://docs.immutable.com/api-reference/chains/list-supported-chains.md): List supported chains
- [Get collection by contract address](https://docs.immutable.com/api-reference/collections/get-collection-by-contract-address.md): Get collection by contract address
- [List all collections](https://docs.immutable.com/api-reference/collections/list-all-collections.md): List all collections
- [List collections by NFT owner](https://docs.immutable.com/api-reference/collections/list-collections-by-nft-owner.md): List collections by NFT owner account address
- [Refresh collection metadata](https://docs.immutable.com/api-reference/collections/refresh-collection-metadata.md): Refresh collection metadata
- [Refresh collection metadata internal](https://docs.immutable.com/api-reference/collections/refresh-collection-metadata-internal.md): Refresh collection metadata internal
- [Sign a crafting payload](https://docs.immutable.com/api-reference/crafting/sign-a-crafting-payload.md): Sign a crafting payload
- [Get list of metadata attribute filters](https://docs.immutable.com/api-reference/metadata-search/get-list-of-metadata-attribute-filters.md): Get list of metadata filters
- [Search NFT stacks](https://docs.immutable.com/api-reference/metadata-search/search-nft-stacks.md): Search NFT stacks
- [Search NFTs](https://docs.immutable.com/api-reference/metadata-search/search-nfts.md): Search NFTs
- [Get a list of metadata from the given chain](https://docs.immutable.com/api-reference/metadata/get-a-list-of-metadata-from-the-given-chain.md): Get a list of metadata from the given chain
- [Get a list of metadata from the given contract](https://docs.immutable.com/api-reference/metadata/get-a-list-of-metadata-from-the-given-contract.md): Get a list of metadata from the given contract
- [Get metadata by ID](https://docs.immutable.com/api-reference/metadata/get-metadata-by-id.md): Get metadata by ID
- [List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack](https://docs.immutable.com/api-reference/metadata/list-nft-stack-bundles-by-stack_id-response-will-include-market-listings-&-stack-count-information-for-each-stack.md): List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.
- [Refresh NFT metadata](https://docs.immutable.com/api-reference/metadata/refresh-nft-metadata.md): Refresh NFT metadata
- [Refresh stacked metadata](https://docs.immutable.com/api-reference/metadata/refresh-stacked-metadata.md): Refresh stacked metadata
- [List all NFT owners](https://docs.immutable.com/api-reference/nft-owners/list-all-nft-owners.md): List all NFT owners on a chain
- [List NFT owners by token ID](https://docs.immutable.com/api-reference/nft-owners/list-nft-owners-by-token-id.md): List NFT owners by token ID
- [List owners by contract address](https://docs.immutable.com/api-reference/nft-owners/list-owners-by-contract-address.md): List owners by contract address
- [Get mint request by reference ID](https://docs.immutable.com/api-reference/nfts/get-mint-request-by-reference-id.md): Retrieve the status of a mint request identified by its reference_id
- [Get NFT by token ID](https://docs.immutable.com/api-reference/nfts/get-nft-by-token-id.md): Get NFT by token ID
- [List all NFTs](https://docs.immutable.com/api-reference/nfts/list-all-nfts.md): List all NFTs on a chain
- [List mint requests](https://docs.immutable.com/api-reference/nfts/list-mint-requests.md): Retrieve the status of all mints for a given contract address
- [List NFTs by account address](https://docs.immutable.com/api-reference/nfts/list-nfts-by-account-address.md): List NFTs by account address
- [List NFTs by contract address](https://docs.immutable.com/api-reference/nfts/list-nfts-by-contract-address.md): List NFTs by contract address
- [Mint NFTs](https://docs.immutable.com/api-reference/nfts/mint-nfts.md): Create a mint request to mint a set of NFTs for a given collection
- [Cancel one or more orders](https://docs.immutable.com/api-reference/orders/cancel-one-or-more-orders.md): Cancel one or more orders
- [Create a bid](https://docs.immutable.com/api-reference/orders/create-a-bid.md): Create a bid
- [Create a collection bid](https://docs.immutable.com/api-reference/orders/create-a-collection-bid.md): Create a collection bid
- [Create a listing](https://docs.immutable.com/api-reference/orders/create-a-listing.md): Create a listing
- [Create a trait bid](https://docs.immutable.com/api-reference/orders/create-a-trait-bid.md): Create a trait bid on NFTs matching specific trait criteria within a collection
- [Get a single bid by ID](https://docs.immutable.com/api-reference/orders/get-a-single-bid-by-id.md): Get a single bid by ID
- [Get a single collection bid by ID](https://docs.immutable.com/api-reference/orders/get-a-single-collection-bid-by-id.md): Get a single collection bid by ID
- [Get a single listing by ID](https://docs.immutable.com/api-reference/orders/get-a-single-listing-by-id.md): Get a single listing by ID
- [Get a single trade by ID](https://docs.immutable.com/api-reference/orders/get-a-single-trade-by-id.md): Get a single trade by ID
- [Get a single trait bid by ID](https://docs.immutable.com/api-reference/orders/get-a-single-trait-bid-by-id.md): Get a single trait bid by ID
- [List all bids](https://docs.immutable.com/api-reference/orders/list-all-bids.md): List all bids
- [List all collection bids](https://docs.immutable.com/api-reference/orders/list-all-collection-bids.md): List all collection bids
- [List all listings](https://docs.immutable.com/api-reference/orders/list-all-listings.md): List all listings
- [List all trades](https://docs.immutable.com/api-reference/orders/list-all-trades.md): List all trades
- [List all trait bids](https://docs.immutable.com/api-reference/orders/list-all-trait-bids.md): List all trait bids
- [Retrieve fulfillment data for orders](https://docs.immutable.com/api-reference/orders/retrieve-fulfillment-data-for-orders.md): Retrieve signed fulfillment data based on the list of order IDs and corresponding fees.
- [Get all info for a Passport user](https://docs.immutable.com/api-reference/passport-profile/get-all-info-for-a-passport-user.md): Get all the info for an authenticated Passport user
- [Get profile for authenticated user](https://docs.immutable.com/api-reference/passport-profile/get-profile-for-authenticated-user.md): Get profile for the authenticated user's Passport wallet
- [Link wallet v2](https://docs.immutable.com/api-reference/passport-profile/link-wallet-v2.md): Link an external EOA wallet to an Immutable Passport account by providing an EIP-712 signature.
- [Send phone OTP code for user supplied phone number](https://docs.immutable.com/api-reference/passport-profile/send-phone-otp-code-for-user-supplied-phone-number.md): Send phone OTP code for user supplied phone number
- [Update username](https://docs.immutable.com/api-reference/passport-profile/update-username.md): Update username for the authenticated user's Passport wallet
- [Verify phone OTP code against user phone number](https://docs.immutable.com/api-reference/passport-profile/verify-phone-otp-code-against-user-phone-number.md): Verify phone OTP code for user supplied phone number
- [Get Ethereum linked addresses for a user](https://docs.immutable.com/api-reference/passport/get-ethereum-linked-addresses-for-a-user.md): This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.
- [Get pricing data for a list of stack ids](https://docs.immutable.com/api-reference/pricing/get-pricing-data-for-a-list-of-stack-ids.md): Get pricing data for a list of stack ids
- [Get pricing data for a list of token ids](https://docs.immutable.com/api-reference/pricing/get-pricing-data-for-a-list-of-token-ids.md): pricing data for a list of token ids
- [Get single ERC20 token](https://docs.immutable.com/api-reference/tokens/get-single-erc20-token.md): Get single ERC20 token
- [List ERC20 tokens](https://docs.immutable.com/api-reference/tokens/list-erc20-tokens.md): List ERC20 tokens
- [Admin Security](https://docs.immutable.com/docs/guides/admin-security.md): Secure wallet management and studio security best practices
- [Build a Game](https://docs.immutable.com/docs/guides/build-a-game.md)
- [Build a Marketplace](https://docs.immutable.com/docs/guides/build-a-marketplace.md)
- [Immutable](https://docs.immutable.com/docs/immutable.md): Supercharge your game's growth with Immutable's next-generation infrastructure
- [Crafting](https://docs.immutable.com/docs/products/asset-contracts/crafting.md)
- [Deploy Contracts with Hardhat](https://docs.immutable.com/docs/products/asset-contracts/deploy-contracts-with-hardhat.md)
- [ERC-1155 (Multi-Tokens)](https://docs.immutable.com/docs/products/asset-contracts/erc1155.md)
- [ERC-20 (In-Game Currencies)](https://docs.immutable.com/docs/products/asset-contracts/erc20.md)
- [ERC-721 (NFTs)](https://docs.immutable.com/docs/products/asset-contracts/erc721.md)
- [Minting API](https://docs.immutable.com/docs/products/asset-contracts/minting-api.md)
- [Operator Allowlist](https://docs.immutable.com/docs/products/asset-contracts/operator-allowlist.md)
- [Asset Contracts](https://docs.immutable.com/docs/products/asset-contracts/overview.md): Pre-built smart contracts for NFTs and in-game currencies
- [Royalties](https://docs.immutable.com/docs/products/asset-contracts/royalties.md)
- [Amplify](https://docs.immutable.com/docs/products/audience/amplify.md)
- [Attribution](https://docs.immutable.com/docs/products/audience/attribution.md)
- [Data Dictionary](https://docs.immutable.com/docs/products/audience/data-dictionary.md): Complete reference of data collected and event schemas across the Tracking Pixel, Web SDK, and REST API
- [Engagement](https://docs.immutable.com/docs/products/audience/engagement.md)
- [Game Page](https://docs.immutable.com/docs/products/audience/game-page.md)
- [Audience](https://docs.immutable.com/docs/products/audience/overview.md): Turn cold, anonymous waitlists into hot launches
- [Questing](https://docs.immutable.com/docs/products/audience/questing.md): Keep players engaged with in-game and pre-launch quest systems
- [REST API](https://docs.immutable.com/docs/products/audience/rest-api.md): Send events directly from your backend, game server, or payment webhook. No browser or client-side library required.
- [Tracking Pixel](https://docs.immutable.com/docs/products/audience/tracking-pixel.md): Lightweight JavaScript snippet for marketing sites. Passively captures page views, attribution, and interactions with no SDK installation
- [Web SDK](https://docs.immutable.com/docs/products/audience/web-sdk.md): Typed tracking SDK for websites and web games. Tracks player progressions, spend, sign-ups, and attribution signals
- [Bridge](https://docs.immutable.com/docs/products/checkout/bridge.md)
- [Connect](https://docs.immutable.com/docs/products/checkout/connect.md)
- [Fund](https://docs.immutable.com/docs/products/checkout/fund.md)
- [Onramp](https://docs.immutable.com/docs/products/checkout/onramp.md)
- [Checkout](https://docs.immutable.com/docs/products/checkout/overview.md)
- [Primary Sales](https://docs.immutable.com/docs/products/checkout/primary-sales.md)
- [Swap](https://docs.immutable.com/docs/products/checkout/swap.md)
- [Wallet](https://docs.immutable.com/docs/products/checkout/wallet.md)
- [API Keys](https://docs.immutable.com/docs/products/hub/api-keys.md): Manage publishable and secret API keys for your Immutable project
- [Deploy Contracts](https://docs.immutable.com/docs/products/hub/deploy-contracts.md): Deploy smart contracts through Hub without writing code
- [Getting Started](https://docs.immutable.com/docs/products/hub/getting-started.md): Create your Immutable Hub account, project, and get your API credentials
- [Hub](https://docs.immutable.com/docs/products/hub/overview.md): Admin panel for managing your game on Immutable
- [Passport Clients](https://docs.immutable.com/docs/products/hub/passport-clients.md): Configure Passport authentication clients for your game or application
- [Team Management](https://docs.immutable.com/docs/products/hub/team-management.md): Invite team members and manage permissions in Immutable Hub
- [Webhooks](https://docs.immutable.com/docs/products/hub/webhooks.md): Configure real-time notifications for blockchain events in Hub
- [Bridging](https://docs.immutable.com/docs/products/immutable-chain/bridging.md)
- [Differences from Ethereum](https://docs.immutable.com/docs/products/immutable-chain/differences-from-ethereum.md)
- [Ecosystem Partners](https://docs.immutable.com/docs/products/immutable-chain/ecosystem-partners.md)
- [Faucet](https://docs.immutable.com/docs/products/immutable-chain/faucet.md)
- [Immutable X Deprecation](https://docs.immutable.com/docs/products/immutable-chain/immutable-x-deprecation.md)
- [Native Token](https://docs.immutable.com/docs/products/immutable-chain/native-token.md)
- [Immutable Chain](https://docs.immutable.com/docs/products/immutable-chain/overview.md): The gaming-optimised blockchain built on Ethereum
- [Running Nodes](https://docs.immutable.com/docs/products/immutable-chain/running-nodes.md)
- [Metadata Search](https://docs.immutable.com/docs/products/indexer/metadata-search.md)
- [Indexer](https://docs.immutable.com/docs/products/indexer/overview.md)
- [Bulk Operations](https://docs.immutable.com/docs/products/orderbook/bulk-operations.md): Create multiple listings and fulfill multiple orders in single transactions for efficient marketplace operations
- [Cancel Orders](https://docs.immutable.com/docs/products/orderbook/cancel-orders.md): Complete guide to cancelling NFT orders with soft (gasless) and hard (on-chain) cancellation
- [Collection Bids](https://docs.immutable.com/docs/products/orderbook/collection-bids.md)
- [Create Listings](https://docs.immutable.com/docs/products/orderbook/create-listings.md): Comprehensive guide to creating NFT listings using the Immutable Orderbook SDK
- [Fees](https://docs.immutable.com/docs/products/orderbook/fees.md)
- [Fill Orders](https://docs.immutable.com/docs/products/orderbook/fill-orders.md): Complete guide to fulfilling NFT orders (buying) using the Immutable Orderbook SDK
- [Order Management](https://docs.immutable.com/docs/products/orderbook/order-management.md)
- [Orderbook](https://docs.immutable.com/docs/products/orderbook/overview.md)
- [Trait bids](https://docs.immutable.com/docs/products/orderbook/trait-bids.md)
- [Architecture](https://docs.immutable.com/docs/products/passport/architecture.md): How Passport secures user wallets with distributed key management
- [Authentication](https://docs.immutable.com/docs/products/passport/authentication.md)
- [Gas Sponsorship](https://docs.immutable.com/docs/products/passport/gas-sponsorship.md): Understanding gas sponsorship on Immutable zkEVM
- [Passport](https://docs.immutable.com/docs/products/passport/overview.md): Seamless authentication and embedded wallets for games
- [Pre-Approved Transactions](https://docs.immutable.com/docs/products/passport/pre-approved-transactions.md): Enable seamless in-game transactions without confirmation popups for immersive gameplay
- [Wallet](https://docs.immutable.com/docs/products/passport/wallet.md)
- [Play](https://docs.immutable.com/docs/products/play.md): Game discovery and wallet management for players
- [Weekly Rewards](https://docs.immutable.com/docs/products/play/weekly-rewards.md): Earn IMX tokens, bonus Gems, and exclusive prizes every week
- [Game Bridge Architecture](https://docs.immutable.com/docs/sdks/game-bridge-architecture.md)
- [FAQ](https://docs.immutable.com/docs/sdks/typescript/faq.md)
- [TypeScript SDK](https://docs.immutable.com/docs/sdks/typescript/overview.md)
- [Advanced Configuration](https://docs.immutable.com/docs/sdks/unity/advanced-configuration.md): Custom WebView, IL2CPP support, and advanced SDK configuration
- [FAQ](https://docs.immutable.com/docs/sdks/unity/faq.md)
- [Unity SDK](https://docs.immutable.com/docs/sdks/unity/overview.md)
- [FAQ](https://docs.immutable.com/docs/sdks/unreal/faq.md)
- [Unreal SDK](https://docs.immutable.com/docs/sdks/unreal/overview.md)

## OpenAPI Specs

- [openapi](https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json)