Metadata
Returns publish freshness information for the currently published version of the requested database: when it was last updated, how many entries the dataset contains, and the size of each output format in bytes.
Authorization
ApiKeyAuthapikey in query
UUID-format API key issued to the customer. Each key is authorized for a specific set of database ids; requesting any other id returns 403.
v1 only. The v2 endpoints take a console-issued key as a bearer token.
Query parameters
idrequiredstringDatabase identifier (e.g. vpn_ip_v1, resproxy_provider_v1).
Match ^[a-zA-Z0-9_]+$ · Example vpn_ip_v1
Responses
200application/json
Metadata for the requested database.
rcrequired"SUCCESS"datarequiredobject
updatedrequiredstring (date)ISO-8601 calendar date (YYYY-MM-DD) on which the currently published version was generated.
Example 2026-04-25
entriesrequiredinteger (int64)Number of data rows in the published dataset (excluding the CSV header).
Min 0 · Example 114000000
sizerequiredobject
Sizes in bytes of the published files, keyed by format.
csvgzrequiredinteger (int64)Size of the gzipped CSV file in bytes.
Min 0
mmdbinteger (int64)Size of the MMDB file in bytes (omitted when the dataset has no MMDB output).
Min 0
TypeScript type
{
rc: "SUCCESS";
data: {
updated: string;
entries: number;
size: {
csvgz: number;
mmdb?: number;
};
};
}400application/json
The request query parameters were malformed.
Possible rc values: INVALID_FORMAT, INVALID_ID.
object | object
Option 1object
rcrequired"INVALID_FORMAT"Option 2object
rcrequired"INVALID_ID"TypeScript type
{
rc: "INVALID_FORMAT";
} | {
rc: "INVALID_ID";
}401application/json
The apikey query parameter was missing or not recognized.
rcrequired"INVALID_APIKEY"TypeScript type
{
rc: "INVALID_APIKEY";
}403application/json
The apikey is valid but is not authorized for the requested database id.
rcrequired"UNAUTHORIZED_ID"TypeScript type
{
rc: "UNAUTHORIZED_ID";
}404application/json
The requested database file does not exist on the server.
rcrequired"DB_NOT_FOUND"TypeScript type
{
rc: "DB_NOT_FOUND";
}