API Reference
Manage your Vital Data proxies programmatically.
Authentication
Every request requires an API key in the X-Vital-Api-Key header. Find or rotate your API key in Developer settings.
Data units
All data amounts use decimal bytes: 1 GB = 1,000,000,000 bytes.
Rate limits
Limits apply per API key every 10 seconds:
Production
Manage residential packages, profiles, and proxies.
Lists residential packages with balances, credentials, and profiles.
curl https://api.vital-data.io/public/residential/packages \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN'
{
"success": true,
"data": [
{
"plan": "standard",
"label": "string",
"pricePerGbUsd": 0,
"totalBytes": 1,
"usedBytes": 1,
"lastPurchase": {
"at": "2026-09-06T21:21:56.543Z",
"quantity": 1
},
"remainingBytes": 0,
"subusers": [
{
"id": "string",
"name": "string",
"isMain": true,
"allocatedBytes": 1,
"usedBytes": 1,
"createdAt": "2026-09-06T21:21:56.543Z",
"username": "string",
"password": "string",
"remainingBytes": 0
}
]
}
]
}Residential packages.
Creates a residential profile with an optional data allocation from Main.
Bytes. 1 GB = 1,000,000,000 bytes.
curl https://api.vital-data.io/public/residential/profiles \
--request POST \
--header 'Content-Type: application/json' \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN' \
--data '{
"plan": "standard",
"name": "Scrapers",
"allocatedBytes": 5000000000
}'
{
"success": true,
"data": {
"id": "string",
"name": "string",
"isMain": true,
"allocatedBytes": 1,
"usedBytes": 1,
"createdAt": "2026-09-06T21:21:56.543Z",
"username": "string",
"password": "string",
"remainingBytes": 0
}
}Created profile and credentials.
Renames a residential profile. Main cannot be renamed.
Pattern: ^[1-9]\d*$curl 'https://api.vital-data.io/public/residential/profiles/{id}' \
--request PATCH \
--header 'Content-Type: application/json' \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN' \
--data '{
"name": "Search jobs"
}'
{
"success": true,
"data": {
"id": "string",
"name": "string",
"isMain": true,
"allocatedBytes": 1,
"usedBytes": 1,
"createdAt": "2026-09-06T21:21:56.543Z",
"username": "string",
"password": "string",
"remainingBytes": 0
}
}Renamed residential profile.
Deletes a residential profile and returns its unused data to Main. Main cannot be deleted.
Pattern: ^[1-9]\d*$curl 'https://api.vital-data.io/public/residential/profiles/{id}' \
--request DELETE \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN'
{
"success": true,
"data": {
"returnedToPoolBytes": 1
}
}Unused bytes returned to Main.
Transfers unused data between profiles on the same residential plan.
Pattern: ^[1-9]\d*$Bytes. 1 GB = 1,000,000,000 bytes.
Pattern: ^[1-9]\d*$curl 'https://api.vital-data.io/public/residential/profiles/{id}/transfer' \
--request POST \
--header 'Content-Type: application/json' \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN' \
--data '{
"fromProfileId": "1",
"amountBytes": 2000000000
}'
{
"success": true,
"data": {
"id": "string",
"name": "string",
"isMain": true,
"allocatedBytes": 1,
"usedBytes": 1,
"createdAt": "2026-09-06T21:21:56.543Z",
"username": "string",
"password": "string",
"remainingBytes": 0
}
}Updated destination profile.
Replaces a residential profile's username and password. Allowed on Main (unlike rename and delete).
Pattern: ^[1-9]\d*$curl 'https://api.vital-data.io/public/residential/profiles/{id}/credentials/rotate' \
--request POST \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN'
{
"success": true,
"data": {
"id": "string",
"name": "string",
"isMain": true,
"allocatedBytes": 1,
"usedBytes": 1,
"createdAt": "2026-09-06T21:21:56.543Z",
"username": "string",
"password": "string",
"remainingBytes": 0
}
}Updated profile and credentials.
Generates up to 10,000 residential proxy connection strings with targeting and session options.
Pattern: ^[1-9]\d*$Integer numbers.
Integer numbers.
curl https://api.vital-data.io/public/residential/generate \
--request POST \
--header 'Content-Type: application/json' \
--header 'X-Vital-Api-Key: YOUR_SECRET_TOKEN' \
--data '{
"profileId": "42",
"protocol": "http",
"gateway": "auto",
"countries": [
"US",
"DE"
],
"state": "CA",
"sessionType": "sticky",
"duration": 60,
"durationUnit": "min",
"outputFormat": "scheme_user_pass_at_ip_port",
"count": 10
}'
{
"success": true,
"data": {
"product": "residential",
"profileId": "string",
"outputFormat": "ip_port_user_pass",
"count": 1,
"proxies": [
{
"protocol": "http",
"host": "string",
"port": 1,
"username": "string",
"password": "string",
"formatted": "string"
}
]
}
}Generated proxies and connection strings.
Manage mobile packages, profiles, and proxies.
View ISP packages and assigned proxies.