Welcome to PyOptimum’s documentation!

This package contains some utility functions to facilitate the connection to the Optimize API and Models API in python.

This library is a simple wrapper of the requests and aiohttp python libraries that helps making token management transparent to the user.

Documentation is limited to the functionality provided by this library. See Optimize API and Models API for a complete API documentation.

See demo for a jupyter notebook demo.

User Guide:

• Quick start
  • Installation
  • Hello World
  • Basic error handling
  • Asynchronous Client
  • Models and Portfolio
  • Learn more

Reference

• Reference
  • Clients
    • Client
    • AsyncClient
  • Model
    • Model
  • Portfolio
    • Portfolio
  • Others
    • PyOptimumException

Indices and tables

• Index

• Module Index

• Search Page