> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.ipxo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome

## Welcome to the IPXO Public API

Use the IPXO API to seamlessly automate your IP infrastructure workflows. You can use the API to programmatically browse the IP marketplace, lease IPv4 subnets, manage routing configurations (LOA/BGP), retrieve automated billing documents, and much more.

## Base URLs

All API requests are made over HTTPS. The API is divided into specific service domains:

* **API Gateway:** `https://apigw.ipxo.com`
* **Authentication (OAuth2):** `https://hydra.ipxo.com/oauth2/token`

Most endpoints are grouped by their service prefix. For example:

* **Billing & Market:** `https://apigw.ipxo.com/billing/v1/{tenant_uuid}/...`
* **Ecommerce & Cart:** `https://apigw.ipxo.com/ecommerce/public/{user_id}/...`
* **Credits & Balances:** `https://apigw.ipxo.com/credits/public/{user_id}/...`

  ***

## Quickstart

Get up and running with your first API call in three steps:

**1. Create API Credentials**

Log in to the [IPXO Portal](https://www.ipxo.com/portal/login) and navigate to **Integrations → Create App** to generate your Client ID and Client Secret.

**2. Generate an Access Token**

Use your credentials to request an OAuth2 Bearer token. [*(See our full Authentication Guide for detailed instructions).*](/guides/auth)

**3. Make your first request**

<Tip>
  **Tip: The Tenant UUID**

  Almost all API requests require your `{tenant_uuid}`. You can find this in your Portal settings, or by making an authenticated `GET` request to `https://apigw.ipxo.com/billing/v1`.
</Tip>

Once you have your token and Tenant UUID, try fetching your current shopping cart:

```shellscript theme={null}
curl "https://apigw.ipxo.com/ecommerce/public/{tenant_uuid}/cart" \
-X GET \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Accept: application/json"
```

***

## Common Workflows

Not sure where to start? Use our step-by-step guides to implement the most common automation flows:

* [**Authentication**](/guides/auth) Learn how to securely generate, use, and refresh your OAuth2 access tokens.
* [**Lease an IPv4 Subnet**](/guides/lease-an-ipv4-subnet) Search the marketplace, add a subnet to your cart, and complete the checkout process.
* [**Leased Subnet Management**](/guides/leased-subnet-management) Assign an ASN, generate Letters of Authorization (LOA), and manage RPKI/ROA records.
* [**Manage Invoices & Payouts**](/guides/check-and-download-invoices) Check your credit balances, download PDF invoices, and track your self-billing payouts.
* [**Terminate a Subscription**](/guides/terminate-a-subscription) Submit cancellation requests for active subnets or services.

***

## API Reference

Ready to dive into the technical details? Use the **API Reference** section in the sidebar to explore all available endpoints, view expected request/response schemas, and test API calls directly from your browser.

## Help

Need help? [Contact IPXO Support](https://www.ipxo.com/contact-us/) or visit our [**Knowledge Base**](https://www.ipxo.com/kb/).