> For the complete documentation index, see [llms.txt](https://moken.gitbook.io/moken-dev-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://moken.gitbook.io/moken-dev-docs/onboard-your-depin/frequently-asked-questions-faq.md). # Frequently Asked Questions (FAQ) ## **What is DePIN Tracker?** DePIN Tracker is a platform designed for monitoring and managing mining devices. It provides a comprehensive view of device statuses, rewards, and associated metadata, making it easier for users to track their mining operations efficiently. *** ## **How do I integrate my miner with DePIN Tracker?** To integrate your miner, follow the API documentation to implement the required endpoints. At least one of the endpoints (`getStatus` or `getRewards`) must be implemented for basic functionality. For a seamless experience, we recommend implementing all available endpoints. *** ## **Can the user's email be used as a device ID?** Yes, but ensure that the email corresponds to only one miner. If an email is associated with multiple miners, it will not be represented correctly. *** ## **Should I paginate my rewards endpoint?** No. DePIN Tracker will call `period=all` only once, so pagination is not necessary for the rewards endpoint. *** ## **What if our existing API endpoints differ from the listed ones?** If your existing API endpoints provide the required data but are structured or named differently, they can still be used for integration. However, we strongly recommend implementing our suggested endpoints to streamline the integration process. If you choose to use your existing API, you must provide us with: * A list of equivalent endpoints. * Rules to extract issues. * The list of issues and their severity levels from your API. * Details on how to extract miner issues from your equivalent endpoints. This includes: * A complete list of issues encountered by miners. * The severity level (`gravity`) of each issue, such as `High`, `Medium`, or `Low`. It is more challenging for us to work with existing endpoints because we do not have deep knowledge of the inner workings of your DePIN system. Providing clear and detailed mappings will reduce potential integration delays and ensure accurate data representation on our platform. *** ## **What is a miner issue?** A miner issue is any problem or abnormal condition reported by the `getStatus` endpoint. These issues indicate the current operational state of the miner and can include: * Connectivity problems (e.g., `Offline`). * Performance-related concerns (e.g., `SpeedTestMissing`). * Configuration errors. Each issue is categorized by its severity (`gravity`) to help users prioritize resolution. *** ## **What happens if `getStatus` returns issues?** * The issue is saved, and we create an 'incident' on our platform. * Depending on the user's alert preferences, they will be notified of the issue. * When `getStatus` indicates that the issue is no longer present, we automatically close the 'incident'. You do not have to handle any of this. All incident management and notifications are handled by the DePIN Tracker platform. *** ## **What level of data security does DePIN Tracker provide?** DePIN Tracker ensures all communications use HTTPS to protect data in transit. Additionally, all API requests require authentication via an `Authorization` header to safeguard access and ensure secure interactions. *** ## **What happens if a miner is offline?** When a miner is offline, the `getStatus` endpoint should return an issue type of `Offline` with a severity level of `High`. This allows users to quickly identify and address downtime. *** ## **Can we add custom metadata to devices?** Yes. If your network uses additional metadata fields (e.g., region, custom tags), these can be incorporated into the integration. Reach out to our team to discuss your specific needs. *** ## **Do you offer support for integrating with DePIN Tracker?** Absolutely. If you encounter any challenges during the integration process, our support team is available to assist you. Contact us to receive guidance or clarification on the requirements and implementation steps. *** If you have further questions, feel free to reach out to our support team for assistance. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://moken.gitbook.io/moken-dev-docs/onboard-your-depin/frequently-asked-questions-faq.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.