Company API
This document explains the available methods and request/response formats for the IP->Company API
Endpoint:
Authentication header:
x-api-key: <YOUR API KEY>
Endpoints:
GET /company
REQUEST
Query Parameters:
| key | value | required |
| ip | Valid IPv4 address | yes |
Example:
?ip=192.168.0.1
RESPONSE
JSON body:
| key | value | required | default |
| domain | Domain of company | no |
n/a |
| company | Company trade name | no | null |
| country | Country where company is based | no | null |
| isISP | Whether or not IP belongs to an ISP | yes | False |
Example:
# If IP belongs to company
{
"domain": "example.com",
"company": "Example INC.",
"country": null,
"isISP": False
}
# If IP does NOT belong to a company
{
"isISP": True
}
POST /company
REQUEST
Post body JSON:
| key | value | required |
| ips | Array of valid IPv4 addresses | yes |
Example:
{
"ips": [
"127.0.0.1",
"192.168.0.1"
]
}
RESPONSE
JSON body:
| key | value |
| provided IP address | Company Object |
Company Object:
| key | value | required | default |
| domain | Domain of company | no |
n/a |
| company | Company trade name | no | null |
| country | Country where company is based | no | null |
| isISP | Whether or not IP belongs to an ISP | yes | False |
Example:
{
"192.168.0.1": {
# If IP belongs to company
"domain": "example.com",
"company": "Example INC.",
"country": null,
"isISP": False
},
"127.0.0.1": {
# If IP does NOT belong to a company
"isISP": True
}
}
No Comments