Metadata-Version: 2.1
Name: variational
Version: 0.2.2
Summary: Variational Reference SDK
Project-URL: Homepage, https://variational.io
Project-URL: Documentation, https://docs.variational.io/for-developers/api
Project-URL: Repository, https://github.com/variational-research/variational-sdk-python/
Project-URL: Issues, https://github.com/variational-research/variational-sdk-python/issues
Author-email: Variational Research <hello@variational.io>
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: brotli>=1.0
Requires-Dist: requests>=2.12
Description-Content-Type: text/markdown

# Variational SDK for Python 

## Documentation

https://docs.variational.io/for-developers/api

## Quickstart

### 1. Create API credentials

Navigate to the API settings page at https://testnet.variational.io/app/settings

<img width="1033" alt="Variational / Settings / API" src="https://github.com/variational-research/variational-sdk-python/assets/155017661/b2cb472b-7742-4c74-9836-12dee28dcfb8">

Add a descriptive label, create your key, and make sure to save the secret as it's only displayed once.

### 2. Install Python SDK

```
pip install variational
```

### 3. Make some requests!

```python
from variational import Client, TESTNET
from pprint import pprint

# FIXME: load from environment variables
API_KEY = "your-api-key"
API_SECRET = "your-api-secret"

client = Client(API_KEY, API_SECRET, base_url=TESTNET)
summary = client.get_portfolio_summary().result
pprint(summary)
```

**Client parameters:**
 - `key`: str (required) — your API key
 - `secret`: str (required) — your API secret
 - `base_url`: str (optional) — prefix of Variational API endpoints
 - `request_timeout`: float (default=None) — timeout for individual HTTP requests
 - `retry_rate_limits`: bool (default=True) — enables automatic retry on HTTP 429 errors


### 4. Explore

Visit [Endpoint Reference](https://docs.variational.io/for-developers/api/endpoints) to learn which API calls are supported.

Read about the [Pagination](https://docs.variational.io/for-developers/api/pagination) mechanism used by Variational API.

Learn how [Rate Limits](https://docs.variational.io/for-developers/api/rate-limits) and [Authentication](https://docs.variational.io/for-developers/api/authentication) are applied to your calls.
