Up-v-ApimaticSDK 0.0.5

Getting Started with Upvest Investment API

Introduction

Upvest Investment API.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package Up-v-ApimaticSDK --version 0.0.5

You can also view the package at: https://www.nuget.org/packages/Up-v-ApimaticSDK/0.0.5

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 Initialization

using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using UpvestInvestmentApi.Standard;
using UpvestInvestmentApi.Standard.Authentication;
using UpvestInvestmentApi.Standard.Http.Signature;
using UpvestInvestmentApi.Standard.Models;

namespace ConsoleApp;

UpvestInvestmentApiClient client = new UpvestInvestmentApiClient.Builder()
    .ClientCredentialsAuth(
        new ClientCredentialsAuthModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .OauthScopes(
            new List<OauthScope>
            {
                OauthScope.Accountsread,
                OauthScope.Accountsadmin,
            })
        .Build())
    .HttpSignature(HttpSignatureCredentials.FromFile(
        keyId: "KeyId",
        privateKeyPath: @"C:\\keys\\upvest-http-sign-key.pem",
        privateKeyPassphrase: "PrivateKeyPassphrase"))
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(UpvestInvestmentApi.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using UpvestInvestmentApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = UpvestInvestmentApiClient
    .FromConfiguration(configuration.GetSection("UpvestInvestmentApi"));

See the Configuration-Based 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 HttpSignature(...) to the client builder -- 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

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse
• HTTP Signatures

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter