AMS-SDK
ams-sdk is a wrapper around ams-api and handles the authentification and query process in just a few steps.
Please refer to AMS API documentation for a detailed description of the API endpoints, including parameters specification.
Features ✨
-
Easy Queries: Query from all AMS API endpoints in two lines of Python code
-
Authentication: SDK takes care of the full authentication process, with just your API key required (given by AMS)
Installation 🛠️
From PyPI (recommended):
pip install ams-sdk
Alternatively, directly from repo:
pip install git+https://github.com/alternative-macro-signals/ams-sdk.git
Requirements 📋
The following dependencies are necessary to use this SDK:
Python 3.7or higher (likely to work with 3+ but not tested)requests>=2.0.0(installed automatically if needed)
Usage 📖
Initialization
First, initialize the AMSClient with the service URL and API key provided by AMS.
from ams_sdk.client import AMSClient
client = AMSClient(service_url=SERVICE_URL, api_key=API_KEY)
Authentication
Call the authenticate() method to fetch the bearer token required for further requests:
client.authenticate()
Querying Endpoints
Use the query_endpoint method to query specific AMS API endpoints:
result = client.query_endpoint("/nbstat", params={
"location": "Japan",
"txt": "rice",
"start": "2023-01-01",
"end": "2025-06-01"
})
print(result)
For /nbstat, location, sector and sign also accept lists — the result
is one combined aggregate series over all the values (Neutral is accepted as
an alias for Undefined):
result = client.query_endpoint("/nbstat", params={
"location": ["US", "UK"],
"sector": ["Core", "Energy"],
})
print(result)
result = client.query_endpoint("/nipi", params={
"location": "China",
"sector": "Food",
})
print(result)
# Query Entropy data (returns all 3 signs: p_neg, p_pos, p_neu)
result = client.query_endpoint("/nipi", params={
"metric": "Entropy",
"location": "US",
"sector": "All",
"start": "2024-01-01"
})
# Query single entropy sign
result = client.query_endpoint("/nipi", params={
"metric": "Entropy",
"location": "US",
"sign": "p_pos" # p_neg, p_pos, or p_neu
})
Note: see /nbstat
and /nipi endpoints documentations for accepted parameters details.
Output
Transform the /nbstat or /nipi output in a Pandas dataframe:
import pandas as pd
df = pd.DataFrame(result.get('content'))
df['date'] = pd.to_datetime(df['date'])
df = df.set_index('date')
df.sort_index(inplace=True)
In order to get 7-day and 30-day rolling balances from /nbstat (similar to the NewsBot app):
df7 = df.rolling(7).mean()
df30 = df.rolling(30).mean()
Note: NIPI is already a 30-day rolling diffusion index.
Entropy output: When querying with metric=Entropy, the response contains 3 rows per date (one for each sign: p_neg, p_pos, p_neu) unless filtered with the sign parameter. The meta.metric_2 field identifies which sign each row represents.
API endpoints callable from AMSClient 🌐
/nbstat 
Retrieve Inflation News Balance and News Volumes associated with specific text queries.
/nipi 
Download NIPI, NVI, or Entropy data. Use the metric parameter to select:
NIPI(default): News Inflation Pressure Index (30-day rolling diffusion index)NVI: News Volume IndexEntropy: Raw entropy values (building blocks of NIPI). Usesignparameter to filter:p_neg,p_pos,p_neu
/newsbot 
Beta — shape may change; not yet in the formal API reference.
The daily Inflation/Wages NewsBot feed (the curated daily news list) as JSON,
latest or by date. Requires a key entitled for this feed (api_newsbot for
inflation, api_newsbot_wages for wages).
Parameters:
| Param | Values | Notes |
|---|---|---|
topic |
inflation (default), wages |
|
tz |
et (London AM), ny (NY PM) |
wages: et only |
date |
YYYY-MM-DD |
omit for the latest edition |
index |
1 |
list available publications (metadata only) |
# latest London-AM inflation newsbot
result = client.query_endpoint("/newsbot", params={"topic": "inflation", "tz": "et"})
# what's available
client.query_endpoint("/newsbot", params={"topic": "inflation", "index": 1})
The response content.payload is the daily news list (a releaseTime plus
numbered items). Each item carries region, loc, stars, title, srce, publishedAt, url, sum, lang, sector and a themes list of category labels
(beta — exposed via the API only).
We welcome suggestions! 💡
📧: support@alternativemacrosignals.com
Project Structure 📂
client.py: Contains theAMSClientclass which offers the core functionality for interacting with the API.utils.py:AMSClientusage examples.setup.py: Handles package configuration and installation details.README.md: Documentation for theams-sdk.
License 📜
This project is licensed under the MIT License. See the LICENSE file for details.
Author
- Author: Laurent Bilke - laurent@alternativemacrosignals.com
- Repository: GitHub
© 2025 Alternative Macro Signals. All rights reserved. https://alt.ms
Metadata
Release files for ams-sdk 1.0.9
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 |
|---|---|---|---|---|
| ams_sdk-1.0.9.tar.gz | 8.2 kB | Without provenance | Details for ams_sdk-1.0.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ams_sdk-1.0.9-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for ams_sdk-1.0.9-py2.py3-none-any.whl |
Total release size: 14.4 kB
Release files / ams_sdk-1.0.9.tar.gz
| Download URL | ams_sdk-1.0.9.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0b81c228419fa79c16c1fd9f3ab3c5ae525370df73ba01874d195977eb071d92
|
|
BLAKE2b-256 checksum How to use checksums |
f81b68b96903b4fefe3e9ca88d471a3dece4b920fc5b36e63c069dba46e44d2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / ams_sdk-1.0.9-py2.py3-none-any.whl
| Download URL | ams_sdk-1.0.9-py2.py3-none-any.whl |
|---|---|
| Size | 6.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
09acf4a8ce5d885950d4127f9bf65f2fa328ce30af5680360ffa3a7e8a6956ea
|
|
BLAKE2b-256 checksum How to use checksums |
20c59dcb27ad14fe055e363ebdf2aeb2eb4bc276d4e963c12759eb26adadf5c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for ams-sdk 1.0.9
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.