Getting Started with Upvest Investment API

Introduction

Upvest Investment API.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install uv-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/uv-apimatic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from upvestinvestmentapi.configuration import Environment
from upvestinvestmentapi.http.auth.oauth_2 import ClientCredentialsAuthCredentials
from upvestinvestmentapi.http.signature import HttpSignatureCredentials
from upvestinvestmentapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from upvestinvestmentapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from upvestinvestmentapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from upvestinvestmentapi.models.oauth_scope import OauthScope
from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient

client = UpvestinvestmentapiClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScope.ACCOUNTSREAD,
            OauthScope.ACCOUNTSADMIN
        ]
    ),
    http_signature_credentials=HttpSignatureCredentials(
        key_id='KeyId',
        private_key_file='/path/to/upvest-http-sign-key.pem',
        private_key_passphrase='PrivateKeyPassphrase'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from upvestinvestmentapi.upvestinvestmentapi_client import UpvestinvestmentapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = UpvestinvestmentapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• oauth-client-credentials (OAuth 2 Client Credentials Grant)

HTTP Signatures

On top of the OAuth 2 token, every request to the Upvest Investment API has to carry a cryptographic signature. The SDK creates it for you once you pass http_signature_credentials to the client — see HTTP Signatures for details.

List of APIs

• Access Tokens
• Webhook Subscriptions
• User Identifiers
• User Checks
• Tax Exemptions
• Tax Wrappers
• Account Groups
• Reference Accounts
• Direct Debits
• Credit Fundings
• Cash Balance Transfers
• Virtual Bank Accounts
• Cash Balances
• Price Data
• Tax Residencies
• Fees Configurations
• Transaction Fees Models
• Portfolios Rebalancing
• Virtual Cash Balances
• Savings Plans
• Securities Transfers
• Account Transfers
• ISA Transfers
• Business Checks
• Files
• Users
• Accounts
• Mandates
• Top-Ups
• Withdrawals
• Instruments
• Orders
• Positions
• Reports
• Transactions
• Fees
• Portfolios
• Valuations
• Liquidations
• Returns
• Tests
• Businesses
• Roles

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest
• HTTP Signatures

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime