Getting Started
The CyberScope API allows developers to programmatically access OSINT data. All endpoints return JSON responses.
Base URL
https://api.cyberscope.io/v1
Authentication
All API requests require an API key passed in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Authentication
Getting Your API Key
- Log in to your CyberScope account
- Navigate to Settings → API Keys
- Click "Generate New Key"
- Copy your API key (store it securely)
API Key Usage
curl -H "Authorization: Bearer sk_test_abc123xyz" \
https://api.cyberscope.io/v1/ip/lookup
IP Lookup API
Endpoint: POST /ip/lookup
POST /v1/ip/lookup
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
{
"ip_address": "8.8.8.8"
}
Response Example
{
"status": "success",
"data": {
"ip": "8.8.8.8",
"country": "United States",
"city": "Mountain View",
"isp": "Google Cloud",
"latitude": 37.386,
"longitude": -122.084
}
}
Query Parameters
- ip_address (required): Valid IPv4 or IPv6 address
Phone Lookup API
Endpoint: POST /phone/lookup
POST /v1/phone/lookup
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
{
"phone_number": "+14155552671"
}
Response Example
{
"status": "success",
"data": {
"phone": "+14155552671",
"country": "United States",
"country_code": "US",
"carrier": "Verizon",
"line_type": "Mobile"
}
}
Query Parameters
- phone_number (required): E.164 format (+country code + number)
Username Lookup API
Endpoint: POST /username/search
POST /v1/username/search
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
{
"username": "john_doe",
"platforms": ["instagram", "github", "twitter", "reddit"]
}
Response Example
{
"status": "success",
"data": {
"username": "john_doe",
"results": {
"instagram": {"found": true, "url": "https://instagram.com/john_doe"},
"github": {"found": true, "url": "https://github.com/john_doe"},
"twitter": {"found": false},
"reddit": {"found": true, "url": "https://reddit.com/user/john_doe"}
}
}
}
Query Parameters
- username (required): Username to search for
- platforms (optional): Array of platforms to search (defaults to all)
Rate Limits
API rate limits are applied per API key:
- Free Plan: 100 requests per day
- Pro Plan: 10,000 requests per day
- Enterprise: Custom limits
Rate limit information is returned in response headers:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1613692800
Error Codes
400
Bad Request - Invalid parameters
401
Unauthorized - Invalid API key
403
Forbidden - Rate limit exceeded
404
Not Found - Resource not found
500
Server Error - Try again later