> For the complete documentation index, see [llms.txt](https://iplytics.gitbook.io/iplytics-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://iplytics.gitbook.io/iplytics-api/master.md).

# API Docs

## Lookup by IP

<mark style="color:blue;">`GET`</mark> `https://api.iplytics.io/v1/lookup`

IP Intelligence Lookup

#### Query Parameters

| Name                                  | Type   | Description |
| ------------------------------------- | ------ | ----------- |
| key<mark style="color:red;">\*</mark> | string | Auth token  |
| ip<mark style="color:red;">\*</mark>  | string | ip address  |

{% tabs %}
{% tab title="200 success" %}

```
{
"ip":"160.34.63.0",
"postal":"59200",
"countryCode":"AU",
"latitude":-33.8591,
"longitude":151.2002,
"ispName":"oracle corporation",
"ASNNumber":63295,
"ASNName":"Oracle Corporation",
"organization":{
    "name":"oracle corporation",
    "domain":"oracle.com",
    "type":"org"
    },
"threat":{
    "is_tor":false,
    "is_proxy":false,
    "is_vpn":false,
    "is_anonymous":false,
    "is_known_attacker":false,
    "is_known_abuser":false,
    "is_threat":false,
    "is_bogon":false
    }
}
```

{% endtab %}

{% tab title="404 Could not process query" %}

```
{
    "message": "could not process your request"
}
```

{% endtab %}

{% tab title="401: Unauthorized Not Valid Key" %}

```javascript
{
   "message":"could not process your request, wrong key"
}
```

{% endtab %}
{% endtabs %}

## Lookup by Name - COMING SOON!

<mark style="color:blue;">`GET`</mark> `https://api.iplytics.io/v1/lookup`

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| name    | string |             |
| country | string |             |
| postal  | string |             |
| domain  | string |             |

#### Headers

| Name           | Type   | Description |
| -------------- | ------ | ----------- |
| Authentication | string |             |

{% tabs %}
{% tab title="200 " %}

```
{
    "ip": "160.34.63.0",
    "postal": "59200",
    "countryCode": "AU",
    "organization": {
        "name": "Oracle Corp",
        "domain": "oracle.com",
        "type": "org"
    },
    "ispName": "Oracle Corp",
    "vpn": False,
    "proxy": False,
    "mobile": False
}
```

{% endtab %}

{% tab title="404 Could not process query" %}

```
{
    "message": "could not process your request"
}
```

{% endtab %}
{% endtabs %}