Skip to main content

Country Flags API

Country Flags is a country flag API that fetches direct download URLs for national flag images using two-letter ISO country codes. Responses return the country name, ISO code, and image link, while paid plans can select SVG or PNG formats and shapes.

PyPI version

This is a Python wrapper for the Country Flags API


Installation

Using pip:

pip install apiverve-countryflags

Using pip3:

pip3 install apiverve-countryflags

Configuration

Before using the Country Flags 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/APIResources/countryflags/circle/png/zw.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766096512&Signature=EfbtYmSr82YpFvV%2FYWRrlA66wKW4j2%2F2n6EDLGnpwhxd9pXvzBQm4xhNVnwRy3tHCvDTWNQTQUaP9kndqcqm5NBlsfzgJlHpBLPLNt3xRBgXwAm5vmPMfoQY%2B%2BHwmYkxBH1H%2BnIkoWeXEsDLoh1MdwUfvTKKP9PDlCyc2FQUJyZoqXxdshHE9l%2Fv019N9z3AipL7jpmeJQnMTDtos8aCa2I9dm%2FzgpMvi2fdMiRfMCNsjlbyug0h0w6wO1W3FLc3K477psnT4BcXARBmn3dYq4hSSLdmhPnKMpCrYXFnhdxZq0VHXNHid1FwLYuMcp%2FPHIJ1%2Fj2OvqMUPEpip%2Fq%2FpA%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)}")

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.


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 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.

Metadata

Release files for apiverve-countryflags 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apiverve-countryflags 1.2.1
File Size Uploaded Provenance
apiverve_countryflags-1.2.1.tar.gz 11.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for apiverve-countryflags 1.2.1
File Interpreter ABI Platform
apiverve_countryflags-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 22.0 kB

Release files / apiverve_countryflags-1.2.1.tar.gz

Download URL apiverve_countryflags-1.2.1.tar.gz
Size 11.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e4a7ace76781115f87a3f68f46e5c9183a0b3354cfb0429139f94029be7783e2
BLAKE2b-256 checksum
How to use checksums
8c9a6cd0ef07bf20bba8bfd73d76c0be863c05032113651fc642d7002322d670
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / apiverve_countryflags-1.2.1-py3-none-any.whl

Download URL apiverve_countryflags-1.2.1-py3-none-any.whl
Size 10.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
98cc4ddd79f5c7702eb0ecb112fcc9e060fa097a00bb2c84d24f96d3296ecadc
BLAKE2b-256 checksum
How to use checksums
5c06b7a7cbf74c62388cc7ddae1e1e4b4d3001004508cddcdf489155b990118d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Security for apiverve-countryflags 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page