Skip to main content

Type-safe Python package for currency data with 250+ entries covering currency codes, symbols, and country associations.

Project description

countrystatecity-currencies

PyPI version Python versions

Official Python package for currency data — 250+ entries covering currency codes, symbols, and country associations. Part of the countrystatecity ecosystem.

Installation

pip install countrystatecity-currencies

Quick Start

from countrystatecity_currencies import (
    get_all_currencies,
    get_currency_by_country,
    get_countries_by_currency,
    search_currencies,
)

# Get all currency entries
currencies = get_all_currencies()
# [Currency(code="AFN", name="Afghan afghani", symbol="؋", countryCode="AF", ...), ...]

# Get the currency for a country
usd = get_currency_by_country("US")
# Currency(code="USD", name="United States dollar", symbol="$", countryCode="US", ...)

# Get all countries using a currency
euro_countries = get_countries_by_currency("EUR")
# [Currency(code="EUR", countryCode="DE", ...), Currency(code="EUR", countryCode="FR", ...), ...]

# Search by code, name, or symbol
results = search_currencies("dollar")
# [Currency(code="USD", ...), Currency(code="CAD", ...), ...]

Data Model

class Currency(BaseModel):
    code: str         # ISO 4217 currency code (e.g., "USD")
    name: str         # Full currency name (e.g., "United States dollar")
    symbol: str       # Currency symbol (e.g., "$")
    countryCode: str  # ISO2 country code (e.g., "US")
    countryName: str  # Country name (e.g., "United States")

API Reference

Function Description
get_all_currencies() Get all currency entries (one per country)
get_currency_by_country(code) Get the currency for an ISO2 country code
get_countries_by_currency(code) Get all countries using an ISO 4217 currency code
search_currencies(query) Search by currency code, name, or symbol

License

ODbL-1.0 — see LICENSE.

Project details


Download files

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

Source Distribution

countrystatecity_currencies-1.0.3.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

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

countrystatecity_currencies-1.0.3-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file countrystatecity_currencies-1.0.3.tar.gz.

File metadata

File hashes

Hashes for countrystatecity_currencies-1.0.3.tar.gz
Algorithm Hash digest
SHA256 e0c1d30fbc3c92ad120e4bbdaa86e077c563de35a0b21b9c60955cd59aaf9669
MD5 d8bccac092c04849a556e959a6fcabfa
BLAKE2b-256 41cfffdaef7621f3f1161672f6faf4aeff85fc3e753e1a3de3a0e044e3c826ae

See more details on using hashes here.

File details

Details for the file countrystatecity_currencies-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for countrystatecity_currencies-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e14635d6e3ceb141fd04b4d5066b20b5db19c9dd4161fe95ed19290bdbcf9379
MD5 44821f0ab40dcf7563ca9fe8e66d1dc6
BLAKE2b-256 39e5f49863085eae7a3f08ac1e48869869082cc1be92ae409432b034a7ab516b

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