simpleapps-com-augur-api
Python client library for Augur microservices.
Installation
pip install simpleapps-com-augur-api
Quick Start
from augur_api import AugurAPI
api = AugurAPI(
token="your-bearer-token",
site_id="your-site-id",
)
# Access any service via api.{service_name}
items = api.items.inv_mast.list(limit=10)
customers = api.customers.customer.list(limit=10)
orders = api.orders.oe_hdr.lookup()
Service Access Pattern
All services are accessed through the unified AugurAPI client:
api.items # Items service
api.customers # Customers service
api.orders # Orders service
api.pricing # Pricing service
api.commerce # Commerce service
# ... one property per service (see https://items.augur-api.com/llms.txt)
Documentation
| Resource | URL |
|---|---|
| Full API Reference | https://augur-api.info |
| Endpoint Hints | https://{service}.augur-api.com/llms.txt |
| Parameters | https://{service}.augur-api.com/endpoints.jsonl |
| OpenAPI Spec | https://{service}.augur-api.com/openapi.json |
Example: Items Service
- https://items.augur-api.com/llms.txt
- https://items.augur-api.com/endpoints.jsonl
- https://items.augur-api.com/openapi.json
Each llms.txt lists all other available services for discovery.
Authentication
All endpoints require:
site_id- Site identifiertoken- Bearer authentication token
api = AugurAPI(
site_id="your-site-id",
token="your-bearer-token",
)
Configuration
from augur_api import AugurAPI, AugurAPIConfig
# With custom configuration
config = AugurAPIConfig(
token="your-bearer-token",
site_id="your-site-id",
timeout=30.0,
retries=3,
retry_delay=1.0,
)
api = AugurAPI.from_config(config)
# From context (for framework integration)
api = AugurAPI.from_context(context)
Edge Caching
Enable Cloudflare edge caching on any GET request using the edge_cache parameter:
# Sub-hour caching
items = api.items.inv_mast.list(limit=10, edge_cache="30s") # 30 seconds
items = api.items.inv_mast.list(limit=10, edge_cache="1m") # 1 minute
items = api.items.inv_mast.list(limit=10, edge_cache="5m") # 5 minutes
# Hourly caching (1, 2, 3, 4, 5, or 8 hours)
items = api.items.inv_mast.list(limit=10, edge_cache=1) # 1 hour
items = api.items.inv_mast.list(limit=10, edge_cache=8) # 8 hours
| Value | Duration |
|---|---|
"30s" |
30 seconds |
"1m" |
1 minute |
"5m" |
5 minutes |
1 - 5, 8 |
1-5 or 8 hours |
The client automatically transforms edge_cache to Cloudflare's cacheSiteId{N} format.
Error Handling
from augur_api import AugurAPI
from augur_api.core.errors import (
AugurError,
AuthenticationError,
NotFoundError,
RateLimitError,
ValidationError,
)
api = AugurAPI(token="...", site_id="...")
try:
response = api.items.inv_mast.get(12345)
except NotFoundError as e:
print(f"Item not found: {e.message}")
except AuthenticationError as e:
print(f"Auth failed: {e.message}")
except RateLimitError as e:
print(f"Rate limited: {e.message}")
except AugurError as e:
print(f"API error: {e.code} - {e.message}")
For AI Agents
See SKILL.md for guidance on using this package with AI assistance.
License
MIT
Metadata
Release files for simpleapps-com-augur-api 2026.9.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| simpleapps_com_augur_api-2026.9.6.tar.gz | 213.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simpleapps_com_augur_api-2026.9.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 343.3 kB
Release files / simpleapps_com_augur_api-2026.9.6.tar.gz
| Download URL | simpleapps_com_augur_api-2026.9.6.tar.gz |
|---|---|
| Size | 213.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ab563f1d327c3eeedea015a400afc9b914df6706a90ab320b9ea4443920329f
|
|
BLAKE2b-256 checksum How to use checksums |
fe1da45ac1bdfd25db46fa8b6da069c2e1d17f7b8578f8336270ec5ef6db408e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / simpleapps_com_augur_api-2026.9.6-py3-none-any.whl
| Download URL | simpleapps_com_augur_api-2026.9.6-py3-none-any.whl |
|---|---|
| Size | 130.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d848bab9af5bcff957ec3f7e68bd47672dc5fd5ecb96e59e257366f916b2c053
|
|
BLAKE2b-256 checksum How to use checksums |
1f9c130cdc32251d35d0a9ee2e5a6190d1cdafc126a4c89ed8d213bb5da1d945
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
