Registry / payments / nominal-api

nominal-api

JSON →
library0.1274.0pypypiunverified

The official Python client for the Nominal API, providing programmatic access to financial time-series data, including inflation, economic indicators, and asset prices. The library is actively maintained and frequently updated, often releasing new versions with minor bug fixes and feature enhancements, though breaking changes can occur in pre-1.0 releases.

pip install nominal-api
INSTALL
IMPORT
SIG · NOMINAL-API
N
nominal-api
paymentspythonv0.1274.0
Install
3.6s avg
Import
Disk
34MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.1274.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 34.5MB
glibc
py 3.103.910 runs
installs and imports cleanly · install 3.6s · import 0.000s · 35MB
34MB installed
● package 34MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

NominalAPIClient
from nominal_api import NominalAPIClient
from nominal_api import NominalAPIClient

Initialize the NominalAPIClient with your API key and fetch time-series data. This example retrieves CPI data for USD for the year 2020. Ensure your API key is configured either as an environment variable or directly in the code.

import os from nominal import NominalAPIClient api_key = os.environ.get('NOMINAL_API_KEY', 'YOUR_NOMINAL_API_KEY_HERE') if api_key == 'YOUR_NOMINAL_API_KEY_HERE': print("Please set the NOMINAL_API_KEY environment variable or replace 'YOUR_NOMINAL_API_KEY_HERE' with your actual key.") else: try: client = NominalAPIClient(api_key=api_key) # Fetch CPI data for USD between specified dates timeseries_data = client.get_timeseries("USD.CPI", "2020-01-01", "2020-12-31") print("Successfully fetched data:") print(f"First entry: {timeseries_data[0]}") print(f"Last entry: {timeseries_data[-1]}") except Exception as e: print(f"An error occurred: {e}")
Debug
Known issues
breakingThe main client class name changed from `NominalClient` to `NominalAPIClient`.
fix
Update your import statement from `from nominal import NominalClient` to `from nominal import NominalAPIClient` and all instantiations.
affects: >=0.1170.0
breakingDate parameters for `get_timeseries` and similar methods now require string formats ('YYYY-MM-DD') instead of `datetime` objects.
fix
Convert any `datetime` objects passed as `start` or `end` parameters to strings using `date_object.strftime('%Y-%m-%d')`.
affects: >=0.1187.0
gotchaThe library is still in a pre-1.0 major version (0.x.x), meaning backward-incompatible changes can be introduced in minor or patch releases.
fix
Always pin your `nominal-api` version in production environments (`nominal-api==X.Y.Z`) and test thoroughly when upgrading to a new version.
affects: <1.0.0
gotchaAPI keys are sensitive. Exposing them in source control or public environments is a security risk.
fix
Always load your `NOMINAL_API_KEY` from environment variables, a secure vault, or a configuration file that is not committed to source control.
affects: All
Upgrade
Version history
0.1274.0latest on PyPI · released Jun 16, 2026
Audit
Dependencies
requestsrequiredUsed internally for making HTTP requests to the Nominal API.
Agent activity
32 hits · last 30 days
node
30
Resources
nominal-api — pip install nominal-api · libregistry