Accessing valid inscriptions associated with a wallet address is a crucial function for developers and users interacting with Bitcoin-based NFTs and BRC-20 tokens. The Fractal Ordinals API provides a powerful, efficient way to retrieve this data through a well-documented endpoint. Whether you're building a marketplace, wallet interface, or analytics dashboard, understanding how to use this API effectively can significantly enhance your Web3 application.
This guide walks you through the complete process of retrieving valid inscription data using the OKX WaaS (Wallet-as-a-Service) Web3 API, focusing on clarity, usability, and integration best practices.
How to Retrieve Valid Inscriptions
The API endpoint allows developers to fetch all valid inscriptions tied to a specific wallet address. This includes both Fractal NFTs and optional BRC-20 token listings, depending on your query parameters.
Endpoint
POST https://web3.okx.com/api/v5/mktplace/nft/fractal-ordinals/get-valid-inscriptionsThis secure POST request ensures sensitive data like wallet addresses are transmitted safely. Unlike public GET endpoints, this method supports complex filtering and pagination while maintaining performance.
Request Parameters Explained
To customize your query, several parameters can be included in the request body. Below is a detailed breakdown of each:
slug(String, Required)
The unique identifier (slug) of the collection you're querying. Each NFT collection has a distinct slug used for routing and lookup.walletAddress(String, Required)
The Bitcoin or ordinals-compatible wallet address from which you want to retrieve valid inscriptions.limit(String, Required)
Sets the maximum number of results per page. Default is10, with a maximum allowed value of100. Use lower values for faster responses in UIs.cursor(String, Optional)
Used for pagination. If your result set spans multiple pages, use the cursor returned in the response to fetch the next batch of data.sort(String, Optional)
Defines the sorting logic for results:listing_time_desc: Sort by listing time, newest firstlisting_time_asc: Oldest listings firstprice_desc: Highest total price firstprice_asc: Lowest total price firstunitprice_desc: Highest unit price firstunitprice_asc: Lowest unit price first
Default:listing_time_desc
isBrc20(Boolean, Optional)
Determines whether to include BRC-20 token listings in the results. Default istrue. Set tofalseif you only want Fractal NFT inscriptions.
👉 Discover how easy it is to integrate blockchain data into your app with OKX’s advanced Web3 APIs.
Understanding the Response Structure
The API returns an array of inscription objects, each containing key metadata about the asset. Here's what each field means:
inscriptionId(String)
A unique identifier for the inscription on the Bitcoin blockchain. This ID is essential for tracking ownership and transferring assets.nftId(String)
Internal NFT identifier used by the platform for database referencing and indexing.ticker(String)
Applies only to BRC-20 tokens. Represents the token symbol (e.g., "ORDI", "SATS").tickerId(String)
Unique identifier for the BRC-20 ticker within the system.amount(String)
The quantity of inscriptions included in the current listing or holding.cursor(String)
Pagination token. Include this value in your next request to retrieve subsequent pages of results.
This structured output makes it easy to parse and display data in web or mobile applications.
Practical Use Cases
1. NFT Marketplace Listings
Build dynamic marketplaces where users can view all valid inscriptions from their wallets. Sort by price or listing time to improve user experience.
2. Portfolio Trackers
Developers can create portfolio dashboards that aggregate NFTs and BRC-20 tokens across multiple collections using the slug and walletAddress filters.
3. Analytics Tools
By leveraging sorting and pagination, analysts can study trends in inscription activity—such as spikes in listing volume or shifts in pricing behavior.
4. Wallet Integrations
Embed this API into self-custodial wallets to provide real-time visibility into ordinals and tokenized assets.
Frequently Asked Questions
Q: Can I retrieve both NFTs and BRC-20 tokens in one request?
A: Yes. By default, when isBrc20 is set to true, the response includes both Fractal NFT inscriptions and BRC-20 listings linked to the wallet address.
Q: What happens if I don’t provide a cursor?
A: The API will return the first page of results based on your limit and sort settings. To access additional pages, use the cursor provided in the response.
Q: Is there a rate limit for this API?
A: While exact limits depend on your access tier, standard usage is generally sufficient for most applications. For high-frequency needs, consider caching strategies or upgrading your plan.
Q: How up-to-date is the inscription data?
A: The API pulls near real-time data from the blockchain indexers, ensuring minimal delay between on-chain events and availability via the endpoint.
Q: Can I filter by multiple slugs at once?
A: Not directly in a single call. You’ll need to make separate requests for each collection slug unless you have access to a batch query endpoint.
👉 See how top Web3 platforms streamline ordinals data retrieval with OKX’s robust API suite.
Best Practices for Integration
- Always validate inputs: Ensure wallet addresses follow correct formats (e.g., Bitcoin P2TR or ordinals-compatible formats).
- Use pagination wisely: Avoid setting
limit=100unless necessary; smaller batches reduce load times and improve UX. - Implement error handling: Handle cases where no inscriptions exist or invalid slugs are provided.
- Cache responses: For read-heavy apps, cache results temporarily to reduce redundant calls.
- Secure your keys: Since this is a private API endpoint, ensure authentication tokens are stored securely and never exposed client-side.
Core Keywords
The primary keywords naturally integrated throughout this article include:
- Fractal Ordinals API
- Retrieve valid inscriptions
- Web3 API
- WaaS
- BRC-20 listings
- NFT marketplace API
- wallet address query
- blockchain inscription data
These terms align with common search queries from developers and businesses exploring Bitcoin-native digital assets and their integration into modern applications.
Final Thoughts
The ability to retrieve valid inscriptions by wallet address opens up powerful possibilities in the world of Bitcoin ordinals and tokenized assets. With the Fractal Ordinals API, developers gain access to structured, sortable, and paginated data that powers everything from simple balance checks to full-fledged marketplaces.
As the ecosystem around BRC-20 tokens and ordinal NFTs continues to grow, leveraging reliable infrastructure like OKX’s Web3 API suite becomes increasingly important.
👉 Start building smarter Web3 experiences today—explore OKX’s full range of developer tools.