#### Getting Started

# API Documentation

Everything you need to integrate with the HypeProxy.io API.

## Introduction

The HypeProxy.io API lets you manage your proxies programmatically. You can rotate IP addresses, check response times, retrieve your current external IP, and access account information — all through simple REST endpoints.

- **Base URL:** `https://api.hypeproxy.io`
- **Protocol:** HTTPS only
- **Authentication:** JWT Bearer token
- **Format:** JSON responses

## Quick Start

Get started in two steps:

1. Copy your API token from your [dashboard profile page](https://app.hypeproxy.io).
2. Make your first request:

```bash
curl https://api.hypeproxy.io/Utils/GetInformations \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

## Available Endpoints

| Method | Endpoint | Description |
| ------ | -------- | ----------- |
| GET | `/Utils/DirectRenewIp/{proxyId}` | Rotate the IP address of a proxy |
| GET | `/Utils/GetResponseTime/{proxyId}` | Get the response time of a proxy |
| GET | `/Utils/GetExternalIp/{proxyId}` | Get the current external IP of a proxy |
| GET | `/Utils/GetInformations` | Get your account information |

## Authentication

All API requests require a valid JWT token passed in the `Authorization` header as a Bearer token. You can find your token in the [HypeProxy.io dashboard](https://app.hypeproxy.io).

{% see-also title="Authentication" href="/docs/authentication" /%}

## Health Check

You can verify the API is operational by visiting the health check endpoint:

```bash
curl https://api.hypeproxy.io/health
```

You can also check our [service status page](https://status.hypeproxy.io/) for real-time uptime information.