# API

[**XNET API repository**](https://github.com/xnetmobile/api) **can be found on our GitHub.**

### Introduction <a href="#introduction" id="introduction"></a>

The **XNET API** is a comprehensive interface designed to provide network participants with streamlined programmatic access to an array of digital resources. It facilitates the management and retrieval of information related to devices, venues, wallets, organizations, and user accounts, serving as the foundation of the developing XNET core system.

**Key Highlights:**

* **Resource Management:**\
  The main goal of phase 1 is to efficiently manage critical XNET assets. This phase aims to streamline the maintenance, monitoring, and updating of devices, venues, and associated components for deployers and organizations.
* **Future-Ready:**\
  Our API is set to transform resource management. In Phase 2, we'll introduce an advanced explorer tool. Phase 3 will bring live usage and accounting statistics, with continuous upgrades enhancing functionality<br>

The **XNET API** is not just about data retrieval—it’s about providing a dynamic, scalable platform that evolves with the needs of its users, ensuring efficient resource management today and delivering innovative tools for tomorrow.

#### Current Version Beta v0.2.0 <a href="#current-version-beta-v020" id="current-version-beta-v020"></a>

v0.2.0 Beta is Read only. If you are interested in joining the Beta please reach out to an XNET team member in [Discord](https://discord.gg/xnet)&#x20;

*Warning: This version may be modified until the official release of v1.0*

#### Phase 1 <a href="#phase-1" id="phase-1"></a>

* Beta is read only.
* Primarily focused on resource retrieval and management.

#### Future Roadmap <a href="#future-roadmap" id="future-roadmap"></a>

* **Phase 2:** Revamped explorer tool.
* **Phase 3:** Live usage and accounting statistics.
* **Phase 4 & Beyond:** Enhanced fleet management, automated Brownfield onboarding.

***

### Getting Started <a href="#getting-started" id="getting-started"></a>

* **Base URL:**\
  `https://api.xnetmobile.com`
* **Authentication:**\
  All endpoints (except login) require a valid bearer token. Tokens are obtained via the `/auth/login` endpoint.
* **API Specification:**\
  This API is defined using the OpenAPI 3.0.3 specification. You can explore the full details of endpoints, schemas, and responses in the provided spec.

***

### Conclusion <a href="#conclusion" id="conclusion"></a>

The XNET API will serve as your comprehensive gateway to accessing, managing, and interacting with a diverse range of XNET resources. By providing a robust interface, the API facilitates seamless integration with various systems, empowering developers to create innovative applications that leverage the full potential of XNET's offerings.

As the API continues to evolve, you can anticipate a plethora of new features and improvements aimed at enhancing your experience.&#x20;


---

# Agent Instructions: 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:

```
GET https://xnet-mobile.gitbook.io/xnet-mobile-docs/deploy-connect-earn/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.