TL Public API Reference

Introduction

This documentation serves as a comprehensive guide for implementing the Tempico Labs (TL) Public API. The Tempico Labs API is a stateless service that provides various functionalities through well-defined endpoints. All requests to the API must be validated using an API key, and the server responses are returned in JSON format.

Access and API Key

To access the TL API, an API key is required. There are two ways to obtain an API key:

1. Customer Area Portal: The portal provides a self-service interface for managing API keys efficiently.
2. Technical Integration Manager: Alternatively, users can reach out to the dedicated Customer Support service to obtain their API key and get assistance with any queries.

For small non-commercial projects or educational purposes, the Public API is completely free. In such cases, if a request is made without an API key, a temporary key will be assigned and linked to the user's IP address. The temporary key is valid for 24 hours from the time of the first request and is limited to 0.20 EUR .

Billing Response Headers

All server responses include billing-related HTTP headers by default. However, this setting can be overridden for specific API keys. The following billing-related headers are included:

• X-Balance-LastBill: Cost of the last request in EUR.
• X-Balance-Remaining: Remaining balance in EUR.

API Key Usage

While the API key is not mandatory for all requests, but enables additional functionality such as performing extra requests, viewing usage statistics, subscriptions, and downloading malware samples. There are two ways to pass an API key:

HTTP Header: Include the API key in the HTTP header

x-api-key: {api_key}

URL Parameter: Pass as a URL parameter

https://api.itsecurity.ee/v4/ip/1.1.1.1?key={api_key}

Error Handling

In case of errors, the API will return an error message as a string inside the "error" key. Here is a list of possible error messages:

• [400] "Incorrect hash" – Make sure the hash is a valid SHA256 or MD5.
• [400] "Bulk request limit exceeded" – Ensure that the POST body contains 100 lines or less.
• [400] "Requested IPv4/IPv6 is incorrect or bogon" – Verify that the IP is correct and not in the bogon list.
• [401] "Invalid API key" – The provided API key is not valid.
• [402] "The account has no sufficient funds to perform this request" – Insufficient funds in the account.
• [402] "Free API credits are exceeded. Please try again tomorrow or obtain an API key." – Daily free credits exceeded.
• [403] "Account is suspended. Contact support@itsecurity.ee for re-activation." – Account suspension; contact support for re-activation.
• [500] "Internal Server Error" – A generic error indicating a critical issue.