FlamingoProxies API
Integrate Flamingo's high-performance proxy network directly into your software. Automate user management, check data usage, and generate proxies programmatically.
Authentication
All API requests must be authenticated using your unique API Key. You can find your key in the Dashboard Settings.
Pass the key in the X-Api-Key header of every request.
curl -X GET https://flamingoproxies.com/api/plans \ -H "X-Api-Key: YOUR_API_KEY_HERE"
import requests
url = "https://flamingoproxies.com/api/plans"
headers = {
"X-Api-Key": "YOUR_API_KEY_HERE"
}
response = requests.get(url, headers=headers)
print(response.json())
const axios = require('axios');
axios.get('https://flamingoproxies.com/api/plans', {
headers: {
'X-Api-Key': 'YOUR_API_KEY_HERE'
}
})
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error);
});
Get Plans
Retrieve a list of all available proxy plans and their active status for your account. Use the slug from this response for other endpoints.
Request Example
curl -X GET https://flamingoproxies.com/api/plans \ -H "X-Api-Key: YOUR_API_KEY_HERE"
import requests
response = requests.get(
"https://flamingoproxies.com/api/plans",
headers={"X-Api-Key": "YOUR_API_KEY_HERE"}
)
print(response.json())
const axios = require('axios');
axios.get('https://flamingoproxies.com/api/plans', {
headers: { 'X-Api-Key': 'YOUR_API_KEY_HERE' }
})
.then(res => console.log(res.data))
.catch(err => console.error(err));
Response Example
{
"success": true,
"plans": [
{
"slug": "entry",
"plan_id": 1,
"name": "Entry",
"type": "residential",
"is_active": true
},
{
"slug": "mobile",
"plan_id": 7,
"name": "Mobile",
"type": "mobile",
"is_active": false
}
]
}Get Usage
Returns the data balance (in GB) for all your active subscriptions.
Request Example
curl -X GET https://flamingoproxies.com/api/usage \ -H "X-Api-Key: YOUR_API_KEY_HERE"
import requests
response = requests.get(
"https://flamingoproxies.com/api/usage",
headers={"X-Api-Key": "YOUR_API_KEY_HERE"}
)
print(response.json())
const axios = require('axios');
axios.get('https://flamingoproxies.com/api/usage', {
headers: { 'X-Api-Key': 'YOUR_API_KEY_HERE' }
})
.then(res => console.log(res.data))
.catch(err => console.error(err));
Response Example
{
"success": true,
"usage": {
"entry": {
"plan_id": 1,
"plan_name": "Entry",
"available_gb": 4.5,
"used_gb": 0.5,
"total_gb": 5.0
}
}
}Get Locations
Fetch supported countries, regions, cities, or ISPs for a specific plan type.
Query Parameters
| Parameter | Description |
|---|---|
| plan Required | Plan slug (e.g., entry, mobile). |
| type Optional | Data to fetch: countries (default), regions, cities, or isps (mobile only). |
| country | Country code (e.g., us). Required when fetching regions, cities, or ISPs. |
| region | Region name. Required when fetching cities for mobile plans. |
Example Request
curl -X GET "https://flamingoproxies.com/api/locations?plan=entry&country=us" \ -H "X-Api-Key: YOUR_API_KEY_HERE"
import requests
params = {
"plan": "entry",
"country": "us",
"type": "cities"
}
response = requests.get(
"https://flamingoproxies.com/api/locations",
params=params,
headers={"X-Api-Key": "YOUR_API_KEY_HERE"}
)
print(response.json())
const axios = require('axios');
axios.get('https://flamingoproxies.com/api/locations', {
params: { plan: 'entry', country: 'us' },
headers: { 'X-Api-Key': 'YOUR_API_KEY_HERE' }
})
.then(res => console.log(res.data))
.catch(err => console.error(err));
Generate Proxies
Create a formatted list of proxies for immediate use. You can specify location, protocol, and format strings.
Request Example
curl -X POST https://flamingoproxies.com/api/generate-proxies \
-H "X-Api-Key: YOUR_API_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"plan": "entry", "country": "us", "amount": 100}'
import requests
data = {
"plan": "entry",
"country": "us",
"amount": 100
}
response = requests.post(
"https://flamingoproxies.com/api/generate-proxies",
json=data,
headers={"X-Api-Key": "YOUR_API_KEY_HERE"}
)
print(response.json())
const axios = require('axios');
const data = {
plan: 'entry',
country: 'us',
amount: 100
};
axios.post('https://flamingoproxies.com/api/generate-proxies', data, {
headers: { 'X-Api-Key': 'YOUR_API_KEY_HERE' }
})
.then(res => console.log(res.data))
.catch(err => console.error(err));
JSON Body Parameters
| Parameter | Type | Description |
|---|---|---|
| plan Required | String | Plan slug (e.g., standard, mobile). |
| proxy_amount Required | Integer | Number of proxies to generate (Max: 50,000). |
| country | String | Country code (e.g., us). |
| proxy_type | String | sticky (default) or rotating. |
| ttl | Integer | Session duration in minutes (Default: 30). |
| city | String | Specific city name (if available). |
Response Example
{
"success": true,
"count": 1,
"proxies": [
"user-region-us-session-abc1234:password@gw.flamingoproxies.com:12345"
]
}Why Automate with Flamingo API?
Integrating residential proxies directly into your application allows for seamless scalability. Our RESTful API provides endpoints for checking data usage, generating new proxy ports on the fly, and managing your subscription status without logging into the dashboard.
Whether you are building a custom web scraper, a sneaker bot, or an enterprise-grade data intelligence platform, Flamingo's API guarantees you have programmatic access to over 100 million IPs worldwide.
