> ## Documentation Index
> Fetch the complete documentation index at: https://docs.greip.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Country Data
> This method allows you to retrieve detailed information about a country by providing its country code in the request.
The API returns valuable data, such as the country’s name, capital, population, region, and other relevant attributes, enabling you to enrich your applications with geographic context and enhance user experiences.
export const MCPCallout = () => {
return
;
};
## Authentication
Include your API key in the `Authorization` header:
```http theme={null}
Authorization: Bearer
```
API v2 accepts the key only in this header, not in query parameters or request bodies. See [Authentication](/authentication).
### Path parameters
The `ISO 3166-1 alpha-2` format of the country code. [Learn more](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Sample value: `GB`
### Query parameters
The params command is used to determine the data you need in the response.
Expected values: `language`, `flag`, `currency`, and/or `timezone`.
Sample value: `language,currency,timezone`
The format command is used to get a response in a specific format.
Expected values: `JSON`, `XML`, `CSV`, or `Newline`
For more information please refer to [Response format](/options/response-format).
The mode command is used in the development stage to simulate the integration process before releasing it to the production environment.
Expected values: `live`, or `test`.
For more information please refer to [Development environment](/options/development-environment).
Optional label for your own analytics or support correlation (for example a product or channel name).
The user\_id command can be used to identify requests sent by specific users to monitor in the [Events page](/knowledge-base/events-and-alerts/overview).
Expected values: email address, phone number, user id, name, etc.
For more information please refer to [User identifier](/options/user-identifier).
```json Success theme={null}
{
"success": true,
"data": {
"geo": {
"continent": "North America",
"continent_code": "NA",
"continent_geo_name_id": 6255149,
"country": "United States",
"country_code": "US",
"country_geo_name_id": 6252001,
"capital": "Washington, D.C.",
"population": 331002651,
"phone": "1",
"is_eu": false,
"neighbours": "CA,MX,PM",
"tld": ".us"
},
"language": {
"name": "English",
"code": "en",
"native": "English"
},
"currency": {
"name": "United States Dollar",
"code": "USD",
"symbol": "$"
},
"flag": {
"emoji": "🇺🇸",
"unicode": "U+1F1FA U+1F1F8",
"png": {
"1000px": "https://greip.io/img/flags/png1000px/us.png",
"250px": "https://greip.io/img/flags/png250px/us.png",
"100px": "https://greip.io/img/flags/png100px/us.png"
},
"svg": "https://greip.io/img/flags/svg/us.svg"
},
"custom_rules_applied": { "total": 0, "rules": [] }
},
"execution_ms": 0
}
```
```json Error theme={null}
{
"success": false,
"code": 101,
"type": "invalid_key",
"description": "The API Key is missing or invalid."
}
```
### Response properties
`true` when the request succeeded; `false` on error.
Core country attributes (always present when the country code is valid).
Localized continent name.
Continent code.
GeoName ID of the continent.
Localized country name.
ISO 3166-1 alpha-2 country code from the path.
GeoName ID of the country.
Capital city.
Population.
International dialing code.
Whether the country is in the EU.
Comma-separated neighbour country codes.
Country top-level domain (for example `.us`).
Included when `params` contains `language`.
Included when `params` contains `flag`.
Included when `params` contains `currency`.
Custom rules metadata (same shape as other geo endpoints).
Time taken to process the request (milliseconds).
## OpenAPI
````yaml openapi/v2.json GET /lookup/countries/{country_code}
openapi: 3.0.3
info:
title: Greip API v2 (docs playground)
version: 2.0.0
servers:
- url: https://v2.greipapi.com
security: []
paths:
/lookup/countries/{country_code}:
get:
summary: Country data
operationId: lookupCountry
parameters:
- name: country_code
in: path
required: true
schema:
type: string
- name: params
in: query
required: false
schema:
type: string
- name: format
in: query
schema:
type: string
default: JSON
- name: mode
in: query
schema:
type: string
default: live
- name: source
in: query
schema:
type: string
- name: user_id
in: query
schema:
type: string
responses:
'200':
description: OK
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.