# Company API

This document explains the available methods and request/response formats for the IP->Company API

Endpoint:

`<a href="https://api.funnelfuel.io">https://api.funnelfuel.io</a>`

Authentication header:

`x-api-key: <YOUR API KEY>`

Endpoints:

<details id="bkmrk-get-%2Fcompany-request"><summary>GET /company</summary>

**<span style="text-decoration: underline;">REQUEST</span>**

Query Parameters:

<table border="1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr><td>key</td><td>value</td><td>required</td></tr><tr><td>ip</td><td>Valid IPv4 address</td><td>yes</td></tr></tbody></table>

Example:

`?ip=192.168.0.1`

**<span style="text-decoration: underline;">RESPONSE</span>**

JSON body:

<table border="1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 26.4442%;"></col><col style="width: 24.0051%;"></col><col style="width: 24.9141%;"></col><col style="width: 24.765%;"></col></colgroup><tbody><tr><td>key</td><td>value</td><td>required</td><td>default</td></tr><tr><td>domain</td><td>Domain of company</td><td>no</td><td>n/a

</td></tr><tr><td>company</td><td>Company trade name</td><td>no</td><td>null</td></tr><tr><td>country</td><td>Country where company is based</td><td>no</td><td>null</td></tr><tr><td>isISP</td><td>Whether or not IP belongs to an ISP</td><td>yes</td><td>False</td></tr></tbody></table>

Example:

```json
# 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
}
```

</details><details id="bkmrk-post-%2Fcompany-reques"><summary>POST /company</summary>

<span style="text-decoration: underline;">**REQUEST**</span>

Post body JSON:

<table border="1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr><td>key</td><td>value</td><td>required</td></tr><tr><td>ips</td><td>Array of valid IPv4 addresses</td><td>yes</td></tr></tbody></table>

Example:

```json
{
  "ips": [
    "127.0.0.1",
    "192.168.0.1"
  ]
}
```

<span style="text-decoration: underline;">**RESPONSE**</span>

JSON body:

<table border="1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>key</td><td>value</td></tr><tr><td>provided IP address</td><td>Company Object</td></tr></tbody></table>

Company Object:

<table border="1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 26.4442%;"></col><col style="width: 24.0051%;"></col><col style="width: 24.9141%;"></col><col style="width: 24.765%;"></col></colgroup><tbody><tr><td>key</td><td>value</td><td>required</td><td>default</td></tr><tr><td>domain</td><td>Domain of company</td><td>no</td><td>n/a

</td></tr><tr><td>company</td><td>Company trade name</td><td>no</td><td>null</td></tr><tr><td>country</td><td>Country where company is based</td><td>no</td><td>null</td></tr><tr><td>isISP</td><td>Whether or not IP belongs to an ISP</td><td>yes</td><td>False</td></tr></tbody></table>

Example:

```json
{
  "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
  }
}
```

</details>