IP Address API

The IP Address API returns the client's IPv4 and/or IPv6 address. This is a public endpoint that requires no authentication.

Endpoint

https://api.autheona.com/v1/public/ip

Method

POST

Authentication

This endpoint does not require authentication. No access token is needed.

Request Headers

Content-Type: application/json

Rate Limits

Rate limits are enforced per IP address:

• Limit: 10 requests per second
• Window: 1 second

If you exceed the rate limit, implement exponential backoff in your integration.

Request Parameters

This endpoint accepts no request parameters. Simply send a POST request to retrieve your IP address.

Response

Success Response (HTTP 200)

{
  "ipv4_address": "203.0.113.42",
  "ipv6_address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}

Response Fields

Examples

Basic Request (IPv4)

curl -X POST https://api.autheona.com/v1/public/ip \
  -H "Content-Type: application/json"

Response:

{
  "ipv4_address": "203.0.113.42",
  "ipv6_address": null
}

Basic Request (IPv6)

curl -X POST https://api.autheona.com/v1/public/ip \
  -H "Content-Type: application/json"

Response:

{
  "ipv4_address": null,
  "ipv6_address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}

Dual Stack (IPv4 and IPv6)

curl -X POST https://api.autheona.com/v1/public/ip \
  -H "Content-Type: application/json"

Response:

{
  "ipv4_address": "203.0.113.42",
  "ipv6_address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}

Error Responses

Too Many Requests (HTTP 429)

Returned when rate limit is exceeded:

{
  "code": 429,
  "error": "Rate limit exceeded",
  "status": false
}

Internal Server Error (HTTP 500)

Returned when an unexpected error occurs:

{
  "code": 500,
  "error": "Error message describing what went wrong",
  "id": "a7db4e2b-7bc1-4a82-bc19-4ff6a2e7f778",
  "status": false
}

The id field contains a unique identifier for tracking the error.

Best Practices

• Cache results - Cache the IP address response for a short period (e.g., 5 minutes) to reduce API calls
• Handle dual stack - Check both ipv4_address and ipv6_address fields as either may be null
• Respect rate limits - Implement exponential backoff if you receive rate limit errors
• Privacy considerations - Handle IP addresses in compliance with privacy regulations (GDPR, CCPA, etc.)
• Use HTTPS - Always use HTTPS to protect IP address data in transit

Integration Example

async function getClientIP() {
  try {
    const response = await fetch('https://api.autheona.com/v1/public/ip', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      }
    });

    const data = await response.json();
    return data.ipv4_address || data.ipv6_address;
  } catch (error) {
    console.error('Failed to retrieve IP:', error);
    return null;
  }
}

Response Time

Average response time is under 50ms. Response time may vary based on:

• Network latency
• Geographic distance from API servers
• Current server load