Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
REST Countries API
Overview
The REST Countries API provides a RESTful interface to access comprehensive country data, including names, flags, regions, languages, currencies, and more. It is designed to support applications needing geographical and demographic information about countries worldwide. The API supports various endpoints to retrieve country data based on different criteria such as names, codes, currencies, languages, and regions.
Integration Overview
The REST Countries API offers the following integration points to query country-related data:
Supported Integration Action Points
- Get All Countries: Retrieve a list of all countries with optional field filtering.
- Get Independent Countries: Fetch a list of independent countries.
- Get Country by Name: Retrieve country details by full or partial name match.
- Get Country by Code:Fetch country details using ISO 3166-1 alpha-2 or alpha-3 codes.
- Get Countries by Codes: Retrieve multiple countries using a list of codes.
- Get Countries by Currency: Fetch countries that use a specific currency.
- Get Countries by Demonym:Retrieve countries based on their demonym.
- Get Countries by Language: Fetch countries where a specific language is spoken.
- Get Countries by Capital: Retrieve countries with a specific capital city.
- Get Countries by Region:Fetch countries within a specific region.
- Get Countries by Subregion: Retrieve countries within a specific subregion.
- Get Countries by Translation:Fetch countries based on their translated names.
- Generic Service with Field Filtering:Retrieve data for any service with customizable field filtering.
Detailed Integration Documentation
Get All Countries
Operation ID
Get All Countries
Purpose
Retrieves a list of all countries with optional field filtering to customize the response data.
Input Details
-
- Query Parameter: fields (optional, string, e.g., name,flags) – Comma-separated list of fields to include in the response.
Output:
-
- Successful: Returns a JSON array of all countries with specified fields (or all fields if none specified).
- Failure: Returns an error if the fields parameter is malformed.
Workflow Example
1. Send a GET request to /all?fields=name,flags.
2. Parse the JSON response to extract country names and flag URLs.
3. Use the data for display or further processing in your application.
Get Independent Countries
Operation ID
getIndependentCountries
Purpose
Retrieves a list of countries that are independent.
Input Details
-
- Query Parameter: status (required, boolean, e.g., true) – Set to true to filter for independent countries.
Output
- Successful: Returns a JSON array of independent countries.
- Failure: Returns an error if the status parameter is missing or invalid.
Workflow Example
1. Send a GET request to /independent?status=true.
2. Process the response to display or analyze independent countries.
Get Country by Name
Operation ID
getCountryByName
Purpose
Retrieves country details by full or partial name match.
Input Details
- Path Parameter: name (required, string, e.g., Canada) – The country name to search for.
- Query Parameter: fullText (optional, boolean, e.g., true) – Set to true for exact name matching.
Output
- Successful:Returns a JSON object with details of the matching country.
- Failure: Returns an error if no country matches the name.
Workflow Example
1. Send a GET request to /name/Canada?fullText=true.
2. Extract country details such as population, capital, or flag from the response.
Get Country by Code
Operation ID
getCountryByCode
Purpose
Retrieves country details using ISO 3166-1 alpha-2 or alpha-3 codes.
Input Details
- Path Parameter: code (required, string, e.g., US) – The ISO 3166-1 alpha-2 or alpha-3 code.
Output
- Successful:Returns a JSON object with details of the country matching the code.
- Failure: Returns an error if the code is invalid or not found.
Workflow Example
1. Send a GET request to /alpha/US.
2. Use the response data to display country-specific information.
Get Countries by Codes
Operation ID
getCountriesByCodes
Purpose
Retrieves details for multiple countries using a list of ISO codes.
Input Details
- Path Parameter: codes (required, string, e.g., US,GB,FR) – Comma-separated list of ISO 3166-1 codes.
Output
- Successful:Returns a JSON array of countries matching the provided codes.
- Failure: Returns an error if any code is invalid or not found.
Workflow Example
1. Send a GET request to /alpha?codes=US,GB,FR.
2. Process the response to compare or display data for multiple countries.
Get Countries by Currency
Operation ID
getCountriesByCurrency
Purpose
Retrieves countries that use a specific currency.
Input Details
- Path Parameter: currency (required, string, e.g., usd) – The currency code (ISO 4217).
Output
- Successful:Returns a JSON array of countries using the specified currency.
- Failure: Returns an error if the currency code is invalid.
Workflow Example
1. Send a GET request to /currency/usd.
2. Use the response to analyze countries sharing the same currency.
Get Countries by Demonym
Operation ID
getCountriesByDemonym
Purpose
Retrieves countries based on their demonym (e.g., “American”).
Input Details
- Path Parameter: demonym (required, string, e.g., American) – The demonym to search for.
Output
- Successful:Returns a JSON array of countries matching the demonym.
- Failure: Returns an error if no countries match the demonym.
Workflow Example
1. Send a GET request to /demonym/American.
2. Extract relevant country data for further use.
Get Countries by Language
Operation ID
getCountriesByLanguage
Purpose
Retrieves countries where a specific language is spoken.
Input Details
- Path Parameter: language (required, string, e.g., en) – The language code (ISO 639-1).
Output
- Successful: Returns a JSON array of countries speaking the specified language.
- Failure: Returns an error if the language code is invalid.
Workflow Example
1. Send a GET request to /lang/en.
2. Use the response to identify countries with a common language.
Get Countries by Capital
Operation ID
getCountriesByCapital
Purpose
Retrieves countries with a specific capital city.
Input Details
- Path Parameter: capital (required, string, e.g., Paris) – The name of the capital city.
Output
- Successful: Returns a JSON array of countries with the specified capital.
- Failure: Returns an error if no countries match the capital.
Workflow Example
1. Send a GET request to /capital/Paris.
2. Process the response to display country details for the capital.
Get Countries by Region
Operation ID
getCountriesByRegion
Purpose
Retrieves countries within a specific region (e.g., “Europe”).
Input Details
- Path Parameter: region (required, string, e.g., Europe) – The region name.
Output
- Successful: Returns a JSON array of countries in the specified region.
- Failure: Returns an error if the region is invalid.
Workflow Example
1. Send a GET request to /region/Europe.
2. Use the response to analyze or display regional country data.
Get Countries by Subregion
Operation ID
getCountriesBySubregion
Purpose
Retrieves countries within a specific subregion (e.g., “Northern Europe”).
Input Details
- Path Parameter: subregion (required, string, e.g., Northern Europe) – The subregion name.
Output
- Successful:Returns a JSON array of countries in the specified subregion.
- Failure: Returns an error if the subregion is invalid.
Workflow Example
1. Send a GET request to /subregion/Northern Europe.
2. Process the response to focus on subregional data.
Get Countries by Translation
Operation ID
getCountriesByTranslation
Purpose
Retrieves countries based on their translated names (e.g., “Deutschland”).
Input Details
- Path Parameter: translation (required, string, e.g., Deutschland) – The translated country name.
Output
- Successful:Returns a JSON array of countries matching the translated name.
- Failure:Returns an error if no countries match the translation.
Workflow Example
1. Send a GET request to /translation/Deutschland.
2. Extract country details for the matching translation.
Generic Service with Field Filtering
Operation ID
getGenericService
Purpose
Provides a flexible endpoint to query any service with customizable field filtering.
Input Details
- Path Parameter:service (required, string, e.g., all) – The service to query.
- Query Parameter: fields (optional, string, e.g., name,flags,region) – Comma-separated list of fields to include.
Output
- Successful: Returns a JSON response with filtered data for the specified service.
- Failure:Returns an error if the service or fields are invalid.
Workflow Example
1. Send a GET request to /all?fields=name,flags,region.
2. Parse the response to extract specific fields for the requested service.
Workflow Creation with the API
Example Workflow: Building a Country Information Dashboard
Fetch All Countries
- Use the getAllCountries endpoint (/all?fields=name,flags,region) to retrieve a list of countries with their names, flags, and regions.
- Parse the response to populate a dashboard with country names and flags.
Filter by Region
- Use the getCountryByName endpoint (/name/France?fullText=true) to fetch detailed information for a selected country.
- Display details such as population, capital, and languages.
Retrieve Detailed Country Data
- Execute the getQuery action with filter=airport eq ‘ARN’ and flightId eq ‘SK007’ to track a specific flight.
- Save the continuationtoken for retrieving updated flight data.
Monitor API Responses
- Implement error handling to manage invalid inputs or API errors.
- Use logging tools to track API calls and response times for optimization.
Additional Notes
- The API does not require authentication for public use.
- Ensure query parameters are properly formatted (e.g., comma-separated for fields or codes).
- For large datasets (e.g., /all), use the fields parameter to reduce response size and improve performance.
- The API supports CORS, making it suitable for web applications.
- Monitor API usage to avoid exceeding rate limits, if any, and handle errors gracefully.
Pricing
iSolution logo - white - transparent 250 px