> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/api-documentation/getting-started/etiquette-for-using-the-api.md). # Etiquette for Using the API This guide covers a few courtesies we appreciate you following so we can continue providing reliable access to our API. ## Rate Limits To keep performance stable for everyone, our API enforces rate limits. This prevents any single user from overwhelming the system and helps maintain fair access. Please build your code with these limits in mind. You can learn more in our [Rate Limit docs](/api-documentation/getting-started/rate-limits.md). ## Add a Date Range To improve performance and reduce unnecessary load, include a date range in your order based API queries whenever possible. Setting a clear start and end date limits the amount of data returned and keeps responses faster and more efficient. Avoid large open ended queries unless absolutely necessary. For example, instead of requesting “all orders,” request “orders from the past 7 days” or “orders from the past 6 months.” This helps your application handle data more predictably and reduces strain on the system. ## Review Your Queries Regularly review your scheduled or automated API queries to make sure they are still needed. Over time, systems often accumulate outdated or redundant requests, such as duplicate pulls or legacy integrations that are no longer in use. Auditing these queries helps reduce unnecessary API usage and supports overall system performance and reliability. ## Add a Unique User-Agent We strongly recommend including a unique **User-Agent** header in your API requests. This should identify your application and include your store ID, for example: ``` User-Agent: StoreName/Store-ID (your-url.com) ``` Using a custom User-Agent helps us diagnose issues, monitor usage, and contact you if we detect something that may affect your integration. Please keep it consistent and up to date. ## Ask Us If You’re Unsure If you’re building workarounds or making complex requests because something does not quite fit your needs, reach out to us. We’re happy to review your setup and suggest a more efficient option. You can contact us anytime at . Conversations like this help us improve the API for everyone. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.orderdesk.com/api-documentation/getting-started/etiquette-for-using-the-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.