Skip to content
Endpoint reference ยท v1

Countries API

List countries and territories in the WorldClock directory.

GET/api/v1/countries

What It Does

List countries and territories in the WorldClock directory.

HTTP method
GET
Authentication
Public read-only; Bearer keys supported
Version
v1

Parameters

NameTypeRequiredDescription
searchstringNoCountry name search.
Example: Pak

Request Examples

cURL
curl -s 'https://worldclock.to/api/v1/countries?search=Pak'
JavaScript
const response = await fetch("https:\/\/worldclock.to\/api\/v1\/countries?search=Pak");
const result = await response.json();
console.log(result.data);
PHP
$response = wp_remote_get('https://worldclock.to/api/v1/countries?search=Pak');
 = json_decode(wp_remote_retrieve_body(), true);
Python
import requests

response = requests.get("https:\/\/worldclock.to\/api\/v1\/countries?search=Pak")
response.raise_for_status()
print(response.json()["data"])

Example Response

The values below illustrate the response shape. Live current-time fields are generated dynamically by the endpoint.

JSON
{
    "success": true,
    "data": [
        {
            "name": "Pakistan",
            "code": "PK",
            "slug": "pakistan",
            "capital": "Islamabad",
            "region": "Asia",
            "timezones": [
                "Asia/Karachi"
            ],
            "city_count": 22
        }
    ],
    "meta": {
        "version": "v1",
        "total": 1,
        "timestamp": 1788946200
    }
}

Response Properties

Every successful response contains success: true, endpoint-specific data, and a meta object. The table below documents the public fields for this endpoint.

PropertyMeaning
successBoolean indicating whether the request completed successfully.
meta.versionPublished API response version.
meta.timestampUnix timestamp for the API response instant.
meta.timezoneTimezone context used by the response.
meta.rate_limitPer-client fair-use limit and remaining-request information on public transports.
data[]Array of matching country records.
data[].nameCountry or territory name.
data[].codeTwo-letter code.
data[].slugCountry slug used by path endpoints.
data[].capitalBundled capital city.
data[].regionBroad geographic region.
data[].timezonesIANA timezone identifiers used by the country.
data[].city_countNumber of bundled cities for the country.
meta.totalNumber of returned matches.

Errors use success: false with a stable machine-readable error code and a safe human-readable message.

Errors & HTTP Status Codes

  • 400 โ€” invalid or missing parameter.
  • 401 โ€” API key required or invalid when key-only access is enabled.
  • 404 โ€” unknown city, country or endpoint.
  • 429 โ€” configured rate limit reached.
  • 503 โ€” API disabled or maintenance mode.

Rate Limits & Caching

Current fair-use configuration is 60 requests per minute and 5000 requests per day. Cache stable directory/calculation responses where appropriate; treat current-time output as point-in-time data.

Related Endpoints