# Data Warehouse API
### Overview The Warehouse API provides developers and builders with a robust and scalable solution for managing warehouse operations efficiently. This API allows seamless integration with existing systems, enabling streamlined inventory management, order processing, and real-time data synchronization. #### Key Benefits 1. **Scalability**: Easily handle increasing data volumes and transaction loads without compromising performance. 2. **Efficiency**: Automate and optimize warehouse processes to reduce manual effort and errors. 3. **Real-Time Data**: Access up-to-date information on inventory levels, order status, and more. 4. **Integration**: Seamlessly connect with other systems and applications for a unified operational workflow. #### Functionalities * **Inventory Management**: Track and manage stock levels, locations, and movements within the warehouse. * **Order Processing**: Efficiently handle order creation, picking, packing, and shipping operations. * **Real-Time Updates**: Receive real-time notifications and updates on inventory and order statuses. * **Reporting and Analytics**: Generate comprehensive reports and analytics for better decision-making. #### 🔑 Authorization To start using the Warehouse API, all you need is an API key. Go to developers.warehouseapi.com, connect your web3 wallet, create a project, and copy your API key. This API key is all you need to start receiving reliable warehouse data. There are two ways to authorize your API request. Instead of `YOUR_API_KEY`, use the key you got at developers.warehouseapi.com: 1. **Query Parameter** ```shell curl http://warehouse-api.xfi.ms/v1/inventory?api-key=YOUR_API_KEY ``` 2. **Authorization Header** ```shell curl http://warehouse-api.xfi.ms/v1/inventory -H 'api-key: YOUR_API_KEY' ``` #### 📝 Supported Chains List of supported networks with the corresponding ChainID: * **Ethereum**: 1 * **BSC**: 56 * **Polygon**: 137 * **Avalanche**: 43114 * **Arbitrum**: 42161 * **Fantom**: 250 * **CELO**: 42220 * **Optimism**: 10 * **Gnosis**: 100 * **Canto**: 7000 * **Arbitrum Nova**: 42170 For a full list of chains supported, please use the Get All Chains endpoint. For the list of Chain\_IDs, you can refer to [Chainlist](https://chainlist.org/). #### 🚦 Free Tier Plan Limitations Our API is free for personal use, with a few limitations listed below: * **200,000 calls per month** * **5 RPS (Requests Per Second)** * **300 seconds delay for data updates** Premium API plan for commercial usage is $199 per month, which includes 1 million API calls. Any additional 1 million API calls will cost an extra $25. We accept payments via credit card, including Visa, Mastercard, and American Express. You can start a free trial at our developers console. Please reach out here if you have any questions about the Premium API plan. #### 📈 FAQ **Q: Why can I not access all historical data about a certain item?**\ A: For the time being, we currently index and display transaction data only from the date/time they are implemented. This means all transactions that occurred before the implementation date will not be included in transaction lists, aggregates/counts, and charts that involve the pre-implementation time period. You can find the list of implemented features and their dates at our documentation. **Q: How often is data updated?**\ A: Currently, for the Free Tier Plan, there is a 300 seconds delay on all data updates. **Q: Am I sending too many requests?**\ A: The rate limit is 5 concurrent requests per second. **Q: I only receive 20 transactions in the response. How can I look at older transactions?**\ A: Use the `limit` and `offset` query parameters to use pagination. Using the `offset` parameter, you can specify where to start a page. Using the `limit` parameter, you can specify the page size. Some parameters can be unclear. Below are their descriptions: * **chain\_id**: You can look up chain IDs for any EVM-powered network by going to [Chainlist](https://chainlist.org/). * **verified**: We use Token Lists to identify verified tokens. A token is considered verified if present in at least one Token List. For ERC-20 tokens, we use [Token Lists](https://tokenlists.org/). For more info, go to our documentation. * **limit**: This is a parameter used for pagination. Use it to specify the page size. Learn more about pagination here. * **offset**: This is a parameter used for pagination. Use it to specify where to start a page. Learn more about pagination here. **Wallet Category**: * **heavy**: Heavy Trader with $500k+ of trading volume in the last 30 days. * **medium**: Active Trader with $100k-$500k of trading volume in the last 30 days. * **casual**: Casual Trader with $10k-$100k of trading volume in the last 30 days. * **bot**: Trader with 1000+ transactions in the last 30 days. Most likely a bot. * **noob**: All other wallet addresses. #### 💬 Support Need help with our API or want to provide some feedback? Join our Community Discord Server and head to the #api-questions channel, where you can chat with fellow builders! We're excited you're here! 💙