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

# HTTP Json Protocol

## HTTP / JSON protocol

In the common cases ( e.g. web and mobile application development ) the most used method to access remote services, the used interface is HTTP/HTTPS. Such service is IpForensics API.

### Requests

API Key and IP Address are passed as query param\
\
Query parameters are passed by `GET`.

### Responses 

Response is normally JSON array with multiple fields. The key `response` is always present and `metadata`. 

**Successful response** 

response: success means success. 

Successful response example:

```javascript
{
    'status' : true,
    'response' : 'success',
    'code' : '000',
    'message' : ...,
    'metadata' : [...]
}
```

### Error response 

Then `response` is set to the error key and `message` is an error message. After every method definition we list the possible error codes that could be returned. 

Error response example:

```csharp
{
    'status' : false,
    'response' : 'error',
    'code' : "INVALID_API_KEY"
    'message' : 'Your API key is invalid. Make sure you are using the right key or check its value for a typo.',
}

```