vswarehouse
Python client for the vs-warehouse statistical data API — macro and economic time series for New Zealand, Australia, and more.
Installation
pip install vswarehouse
Quick start
from vswarehouse import Client
client = Client("vs_your_api_key")
# List all available series
series = client.list()
# Get metadata for a series
meta = client.info("nz_cpi")
# Fetch data as a pandas DataFrame
df = client.get("nz_cpi", start="2020-01-01")
print(df.head())
Authentication
Pass your key directly or set the VS_API_KEY environment variable:
export VS_API_KEY=vs_your_api_key
client = Client() # reads VS_API_KEY automatically
Get a free API key at api.virtus-solutions.io.
API reference
Client(api_key, base_url)
| Method | Returns | Description |
|---|---|---|
list() |
list[dict] |
All available series with metadata |
info(name) |
dict |
Metadata for a single series |
get(name, start, end, format) |
DataFrame |
Time-series data |
get() parameters
| Param | Type | Description |
|---|---|---|
name |
str |
Series identifier, e.g. "nz_cpi" |
start |
str |
ISO date lower bound, e.g. "2020-01-01" |
end |
str |
ISO date upper bound |
format |
str |
"json" (default) or "csv" |
Exceptions
| Exception | When |
|---|---|
AuthenticationError |
Invalid or inactive API key |
RateLimitError |
Daily free-tier limit reached |
NotFoundError |
Series not found |
APIError |
Other HTTP errors |
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for vswarehouse 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vswarehouse-0.4.0.tar.gz | 7.6 kB | Without provenance | Details for vswarehouse-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vswarehouse-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for vswarehouse-0.4.0-py3-none-any.whl |
Total release size: 14.7 kB
Release files / vswarehouse-0.4.0.tar.gz
| Download URL | vswarehouse-0.4.0.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3956f898e7df249ff384f8399703a2c77a9e229f83f6ad1c29ed15e8122fea4a
|
|
BLAKE2b-256 checksum How to use checksums |
69d75087447e51fda47c0cfbf9ad507d0ee636f4ca9521b03db4e65060d353a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / vswarehouse-0.4.0-py3-none-any.whl
| Download URL | vswarehouse-0.4.0-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0c6f4330dcebc8f6962a242a579ed5b25d8bc594605d1ea873b2c30899601f08
|
|
BLAKE2b-256 checksum How to use checksums |
daae081d63efe3846af9a3b7d33d97553495f881bef10bc1798a21f70e4c6243
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Security for vswarehouse 0.4.0
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
