redatlas 0.1.1

RED Atlas External API

redatlas

Official Python SDK for the RED Atlas External API.

Install

pip install redatlas

Quickstart

from redatlas import RedAtlasClient

client = RedAtlasClient(
    base_url="https://your-api-base-url/external-api",
    api_key="ra_live_...",
)

health = client.health.get()
print(health.status)

Authentication

Use one of these auth options:

• api_key for Data API and report access
• access_token for authenticated account flows
• refresh_token for refresh/logout flows
• admin_key for changelog admin endpoints

from redatlas import RedAtlasClient
from redatlas.models.login_request import LoginRequest

client = RedAtlasClient(base_url="https://your-api-base-url/external-api")
session = client.auth.login(
    LoginRequest(email="[e-mail]", password="secret")
)

print(session.data.access_token)

Examples

from redatlas import RedAtlasClient

client = RedAtlasClient(
    base_url="https://your-api-base-url/external-api",
    api_key="ra_live_...",
)

plans = client.plans.list()
market = client.data.market("col")
records = client.data.list("col", "listings", limit=3)

print(len(plans.data))
print(market.data.available_entities)
print(len(records.data))

Typed request models are available under redatlas.models.

Configuration

RedAtlasClient resolves the base URL in this order:

1. explicit base_url
2. RED_ATLAS_BASE_URL
3. SDK default fallback

Passing base_url explicitly is recommended.

Notes

• The public entrypoint is RedAtlasClient
• The SDK also exposes generated typed request and response models
• Integration tests in this repo verify that wrapper methods forward requests to the expected endpoints with the expected params