Skip to main content

Country Flag is a simple tool for getting the country's national flags. It returns the country's national flags.

Project description

Country Flags API

Country Flag is a simple tool for getting the country's national flags. It returns the country's national flags.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Country Flags API


Installation

Using pip:

pip install apiverve-countryflags

Using pip3:

pip3 install apiverve-countryflags

Configuration

Before using the countryflags API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_countryflags.apiClient import CountryflagsAPIClient

# Initialize the client with your APIVerve API key
api = CountryflagsAPIClient("[YOUR_API_KEY]")

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Country Flags API documentation is found here: https://docs.apiverve.com/ref/countryflags. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_countryflags.apiClient import CountryflagsAPIClient

# Initialize the client with your APIVerve API key
api = CountryflagsAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "country": "Zimbabwe",
    "countryCode": "ZW",
    "shape": "circle",
    "format": "png",
    "downloadUrl": "https://storage.googleapis.com/apiverve.appspot.com/APIResources/countryflags/circle/png/zw.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1740259794&Signature=KayVZkDE4ScEXvYM%2BSveuHPTNbsxAdtUJSKN4S9pCVEaWDBkhSZYX6P0xS3TcTeHuiaetBYgmSj7FvkaDinjFzNtjpxmUd8n%2FoAdvUK%2BIeANBKkw%2B2QMquwpHcMeZPwAiV%2BRbbGU8b1V%2FxtXdiTzkOMWLm%2Bmfipwp4%2FQ5nL8Gr637kj6F5FRPzIJVakORdrE6rWfUCwP4rfiXYZMVLN4zHMZaZb44y8AoFaavt6UAS0wAnaav0XDWjV8OjXC1Oq99DYIJA%2FrvPQHYwBZWBTxMdZ8OSC%2BA2rIinlDaeTj4IrQqsd4AAfAWEs1ESAox0QJcKCXs4mYrJdZLMlN3JEAAA%3D%3D"
  }
}

Error Handling

The API client provides comprehensive error handling through the CountryflagsAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_countryflags.apiClient import CountryflagsAPIClient, CountryflagsAPIClientError

api = CountryflagsAPIClient("[YOUR_API_KEY]")

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except CountryflagsAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_countryflags.apiClient import CountryflagsAPIClient, CountryflagsAPIClientError

api = CountryflagsAPIClient("[YOUR_API_KEY]")

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except CountryflagsAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_countryflags.apiClient import CountryflagsAPIClient, CountryflagsAPIClientError

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

# Using context manager ensures proper cleanup
with CountryflagsAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except CountryflagsAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_countryflags.apiClient import CountryflagsAPIClient

# Enable debug mode
api = CountryflagsAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_countryflags.apiClient import CountryflagsAPIClient

api = CountryflagsAPIClient("[YOUR_API_KEY]")

query = {
    "country": "ZW",
    "format": "png",
    "shape": "circle"
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_countryflags-1.1.14.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_countryflags-1.1.14-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_countryflags-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_countryflags-1.1.14.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_countryflags-1.1.14.tar.gz
Algorithm Hash digest
SHA256 ebbca8099054447a1409801d6ab4ecad5510247f45a85d7a2a178f1d8cc5c35d
MD5 1e4d52d4c43cc14dae06794e4cb6e9ff
BLAKE2b-256 4555364557da2950b1d2747c0aeec9d831fa66b00929e543ab7fa4668ff6835b

See more details on using hashes here.

File details

Details for the file apiverve_countryflags-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_countryflags-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2bcca35bcc7b1b6e16d61bd1dc0a3e0ba3155fe6bb41ad815b539502417add50
MD5 456564bd2b95a5d9c1aa91cf14fe5596
BLAKE2b-256 1bf67cad7adf0f851843eb37d7c34a35a69f9f908bc41dea9ee18d7e9c155caf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page