Documentation

API Documentation

Everything you need to integrate Baalvion NetStack into your applications. Get started with our RESTful API in minutes.

Get API Key

Quick Start

Get Your API Key

Make Your First Request

Use the examples below to get started

Scale Your Integration

Explore advanced features and endpoints

API Keys

Manage your API authentication credentials

Production Key

active

bv_live_••••••••••••••••••••••••••••••••b0c2

Created: Jan 15, 2024Last used: 2 hours ago

Development Key

active

bv_test_••••••••••••••••••••••••••••••••l5m6

Created: Feb 20, 2024Last used: 5 days ago

Keep your API keys secure

Never share your API keys or commit them to version control. Use environment variables in production.

API Endpoints

Available endpoints and their methods

Base URL: https://api.baalvion.com/v1

Method	Endpoint	Description
GET	/api/v1/proxies	List all proxies
POST	/api/v1/proxies/generate	Generate proxy list
GET	/api/v1/usage	Get usage statistics
POST	/api/v1/subusers	Create sub-user
DELETE	/api/v1/subusers/:id	Delete sub-user
GET	/api/v1/proxies/:id	Get proxy details by ID
PUT	/api/v1/subusers/:id	Update sub-user settings
GET	/api/v1/health	Check API health status

Code Examples

Get started quickly with these examples

curl -X GET "https://api.baalvion.com/v1/proxies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Generate proxy list
curl -X POST "https://api.baalvion.com/v1/proxies/generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "residential",
    "country": "US",
    "quantity": 10,
    "protocol": "http"
  }'

Error Codes

HTTP status codes and their meanings

Code	Status	Description
200	OK	Request successful
201	Created	Resource created successfully
400	Bad Request	Invalid request parameters
401	Unauthorized	Invalid or missing API key
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server error, please retry
503	Service Unavailable	Service temporarily unavailable

Rate Limits

API request limits per plan

Plan	Requests/Minute	Requests/Day	Burst Limit
Starter	60	10,000	100
Professional	300	100,000	500
Enterprise	1,000	Unlimited	2,000

Rate Limit Headers

Each API response includes headers to help you track your rate limit status:

X-RateLimit-Limit- Maximum requests per window

X-RateLimit-Remaining- Requests remaining in window

X-RateLimit-Reset- Time when the limit resets (Unix timestamp)

Ready to Start Building?

Get your API key and start integrating Baalvion NetStack into your applications today.

Get API Key View Pricing