Skip to main content

Pydantic AI integration for the UniRate currency-exchange API — a toolset plus tool functions for FX rate lookups, conversion, currency lists, and VAT rates.

Project description

pydantic-ai-unirate

PyPI License: MIT

Pydantic AI integration for the UniRate API — a drop-in currency-exchange toolset for Pydantic AI agents.

UniRate provides 593+ fiat, crypto, and commodity exchange rates. Latest rates, conversion, the currency list, and VAT rates are available on the free tier; historical and time-series endpoints require a Pro plan.

Why this package

Pydantic AI has no built-in FX tool — most examples hand-roll one against exchangerate-api.com or AlphaVantage. This package gives you a typed, tested UniRateToolset (a subclass of pydantic_ai.toolsets.FunctionToolset, i.e. an AbstractToolset) that plugs straight into an Agent, plus the underlying async wrapper and tool functions if you want to compose your own toolset.

Install

pip install pydantic-ai-unirate

Quick start

import os

os.environ["UNIRATE_API_KEY"] = "..."  # https://unirateapi.com

from pydantic_ai import Agent

from pydantic_ai_unirate import UniRateToolset

agent = Agent("openai:gpt-4o-mini", toolsets=[UniRateToolset()])

result = agent.run_sync("How many euros is 250 US dollars right now?")
print(result.output)

The toolset registers four tools the model can call:

Tool Description
get_rate Latest rate for a pair, or every rate for a base currency.
convert Convert an amount from one currency to another.
list_currencies Every currency code UniRate can convert between.
get_vat_rates VAT rates for all countries, or one country.

Direct use of the wrapper

The transport layer is a standalone async client you can call without an agent:

import asyncio

from pydantic_ai_unirate import UniRateAPIWrapper


async def main() -> None:
    async with UniRateAPIWrapper() as unirate:
        print(await unirate.convert("USD", "EUR", amount=100))  # 92.5
        print(await unirate.get_rate("USD", "GBP"))             # 0.79
        print((await unirate.get_supported_currencies())[:5])
        print(await unirate.get_vat_rates("DE"))


asyncio.run(main())

Composing your own toolset

The tool functions are exported so you can register them on an existing FunctionToolset or hand them to an agent individually. Each takes the UniRateAPIWrapper as its first argument:

from pydantic_ai.toolsets import FunctionToolset

from pydantic_ai_unirate import UniRateAPIWrapper, convert, get_rate

wrapper = UniRateAPIWrapper()
toolset = FunctionToolset()
toolset.add_function(lambda from_currency, to_currency: get_rate(wrapper, from_currency, to_currency), name="get_rate")

Configuration

Constructor arg Env var Default
api_key UNIRATE_API_KEY — (required)
base_url https://api.unirateapi.com
timeout 30 (seconds)
enable_historical False (Pro-gated; opt in)

UniRateToolset(api_key=..., enable_historical=..., wrapper=...) forwards to the wrapper; pass a pre-built wrapper= to share an httpx client.

Error handling

Every failure raises a typed subclass of UniRateError:

HTTP status Exception Meaning
400 InvalidRequestError Invalid request parameters
401 AuthenticationError Missing or invalid API key
403 APIError (status_code == 403) Endpoint requires a Pro subscription
404 InvalidCurrencyError Currency not found or no data available
429 RateLimitError Rate limit exceeded
503 APIError (status_code == 503) Service unavailable
transport UniRateError Connection / timeout failure (wrapped)

Related UniRate clients

If you want to call the API directly from a non-Python application, there are official clients in Python, Node.js, Go, Rust, Java, Ruby, PHP, .NET, and Swift, plus a LangChain integration and an MCP server for Claude Desktop and other MCP hosts.

License

MIT — 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

pydantic_ai_unirate-0.1.0.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

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

pydantic_ai_unirate-0.1.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_ai_unirate-0.1.0.tar.gz.

File metadata

  • Download URL: pydantic_ai_unirate-0.1.0.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pydantic_ai_unirate-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a4d3c0912a037a1f559a61d6a98fac7c7a26d2821361940f768970e9bc1d8876
MD5 15fb425f6735b76dd8faf036b5bd810d
BLAKE2b-256 e591ff42bdc5ee1452ef9616cc4995ceea2e98a499f4d10b7d516ee3205c71e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_ai_unirate-0.1.0.tar.gz:

Publisher: release.yml on UniRate-API/pydantic-ai-unirate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydantic_ai_unirate-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_ai_unirate-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c1bec94979338c5819e1e110b544be055b648108d08ddbe8b63208487b7731d
MD5 67665c79534723870f78871ca31a0863
BLAKE2b-256 8f8bb8f5cfdefad4db70018477b8201c97d12b3ef55cab23b221f41586896067

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydantic_ai_unirate-0.1.0-py3-none-any.whl:

Publisher: release.yml on UniRate-API/pydantic-ai-unirate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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