API Documentation Coming Soon
We're working hard to bring you comprehensive API documentation. This will include detailed endpoints, authentication methods, rate limiting information, and code examples in multiple programming languages.
API Preview
Get a sneak peek at what our API will offer:
Basic IP Information
GET
/api/ip
Get basic IP address information
{
"ip": "203.0.113.1",
"version": "IPv4",
"timestamp": "2023-09-02T10:04:00Z"
}
Detailed Information
GET
/api/details
Get comprehensive IP and location details
{
"ip": "203.0.113.1",
"city": "New York",
"region": "New York",
"country": "US",
"country_name": "United States",
"continent": "North America",
"org": "Example ISP",
"timezone": "America/New_York",
"currency": "USD",
"languages": ["en"],
"coordinates": {
"latitude": 40.7128,
"longitude": -74.0060
}
}
Planned Features
- Rate Limiting: 100 requests per hour per IP
- Authentication: API key support for higher limits
- Multiple Formats: JSON, XML, and plain text responses
- HTTPS Only: Secure connections required
- CORS Support: Cross-origin requests enabled
- IPv6 Support: Full support for IPv6 addresses
SDK Examples
When our API launches, here are some examples of how you might use it:
JavaScript/Node.js
// Using fetch API
fetch('https://whatsmyip.example.com/api/details')
.then(response => response.json())
.then(data => {
console.log('Your IP:', data.ip);
console.log('Location:', data.city + ', ' + data.country);
});
Python
import requests
response = requests.get('https://whatsmyip.example.com/api/details')
data = response.json()
print(f"Your IP: {data['ip']}")
print(f"Location: {data['city']}, {data['country']}")
cURL
curl -X GET "https://whatsmyip.example.com/api/details" \
-H "Accept: application/json"