Skip to main content

Official Python SDK for the AUROS Protocol — RWA intelligence API

Project description

auros-protocol (Python)

Official Python SDK for the AUROS Protocol.

Install

pip install auros-protocol

Or from source:

cd packages/auros-protocol-python
pip install -e .

Quickstart

from auros import AurosProtocol

client = AurosProtocol(api_key="auros_pk_test_demo")

result = client.score(
    description="Retail warehouse Luxembourg €2.5M SPV professional investors"
)
print(result["score"], result["grade"], result["mica_classification"])

Methods

Method Endpoint Auth
score(**fields) POST /api/v1/score Bearer
score_batch(**body) POST /api/v1/score/batch Bearer
products(**query) GET /api/v1/products Bearer
jurisdictions(**query) GET /api/v1/jurisdictions Bearer
checklist(**body) POST /api/v1/checklist Bearer
compare(**body) POST /api/v1/compare Bearer
status() GET /api/v1/status None
create_key(email) POST /api/v1/keys None

Examples

# Catalog
bonds = client.products(category="bonds", yield_min=4, limit=10)

# Jurisdictions
ranking = client.jurisdictions(
    asset_type="real_estate",
    investor_type="professional",
    timeline_months=6,
)

# Checklist
items = client.checklist(
    asset_type="real_estate",
    jurisdiction="luxembourg",
    structure="spv",
)

# Compare RWA products
comparison = client.compare(category="bonds", yield_min=4, limit=3)

# API health (no auth)
health = client.status()
print(health["status"], health["version"])

# Free API key
key_resp = client.create_key("you@company.com")
print(key_resp["api_key"])

Context manager

with AurosProtocol(api_key="auros_pk_test_demo") as client:
    print(client.score(description="..."))

Disclaimer

Indicative intelligence only — not legal, tax, or investment advice.

Publish (maintainers)

cd packages/auros-protocol-python
python -m pip install --upgrade build twine
python -m build
python -m twine upload dist/*

Set TWINE_USERNAME=__token__ and TWINE_PASSWORD=pypi-<your-api-token> before upload.

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

auros_protocol-1.0.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

auros_protocol-1.0.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file auros_protocol-1.0.0.tar.gz.

File metadata

  • Download URL: auros_protocol-1.0.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for auros_protocol-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8a829db5b969348cbb5e4b58b3434539021a6fb07ca97c2d32c5e0f09bd02372
MD5 759e42a7470853da98c217f3a8771e69
BLAKE2b-256 60ade68d2e10cf018ded325dc6048a677167947bca923a0065794d6cb96082f2

See more details on using hashes here.

File details

Details for the file auros_protocol-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: auros_protocol-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for auros_protocol-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7784ee9e6889c700dac562fc2b65c1e1e0172f51c7043536447f627f648f92e7
MD5 b6961ab32a2a93d2a5a3a2b655c65254
BLAKE2b-256 d0633ff569fec97513818690f0f7fffebbc8fa2c0974d65a15af265bf28795d2

See more details on using hashes here.

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