upvest-apimatic-poc.pages.dev Open in urlscan Pro
2606:4700:310c::ac42:2f75  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Upvest Investment API

 * REST
 * .NET
 * Java
 * PHP
 * Python
 * Ruby
 * TypeScript
 * Go

 * REST

Get SDK
 * API Spec


Search
Ctrl + K

Setting Up SDKs

 * * Setting Up SDKs
 * Guided Walkthroughs
   * Implementing instruments
 * API Endpoints
   * Access Tokens
   * Files
   * Webhooks
   * Users
   * Accounts
   * Tax Exemptions
   * Reference Accounts
   * Mandates
   * Direct Debits
   * Top-Ups
   * Withdrawals
   * Cash Balances
   * Instruments
   * Orders
   * Positions
   * Reports
   * Tax Residencies
   * Transactions
   * Fees
   * Portfolios
   * Valuations
   * Liquidations
   * Returns
   * Virtual Cash Balances
   * Savings Plans
   * Tests
 * Models
   * Structures
   * Enumerations
   * Exceptions
   * OneOf/AnyOf Definitions

Built with APIMatic
SETTING UP SDKS
#

INTRODUCTION
#

Upvest Investment API.

ENVIRONMENTS
#

This API has support for the following environment(s). Each environment has one
or more base URIs defined.

PRODUCTION
#

ServerBase URIdefaulthttps://api.upvest.co

SANDBOX
#

ServerBase URIdefaulthttps://sandbox.upvest.co

The default environment is Sandbox and the default server is default.

AUTHORIZATION
#

This API uses the following authentication schemes.

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

OAUTH-CLIENT-CREDENTIALS (OAUTH 2 CLIENT CREDENTIALS GRANT)
#

Documentation for accessing and setting credentials for
oauth-client-credentials.

AUTH CREDENTIALS

NameTypeDescriptionOAuthClientIdStringOAuth 2 Client
IDOAuthClientSecretStringOAuth 2 Client SecretOAuthScopesOAuthScopeList of
scopes that apply to the OAuth token

Your application can also manually provide an OAuthToken using the setter in
object. This function takes in an instance of OAuthToken containing information
for authorizing client requests and refreshing the token itself.

You must have initialized the client with scopes for which you need permission
to access.

SCOPES

Scopes enable your application to only request access to the resources it needs
while enabling users to control the amount of access they grant to your
application. The following scopes are available:

Scope NameDescriptionaccounts:readRead accounts and account
groupsaccounts:adminCreate/update/delete accounts and account
groupswebhooks:adminCreate/update/delete webhookswebhooks:readRead
webhooksfiles:readRead files metadataorders:adminCreate/update/delete
ordersorders:readRead ordersusers:adminCreate/update/delete usersusers:readRead
userschecks:adminCreate checkschecks:readRead checkspositions:readRead
positionsreference_accounts:adminCreate/update/delete reference
accountsreference_accounts:readRead reference
accountsmandates:adminCreate/update/delete mandatesmandates:readRead
mandatespayments:adminPayins and withdrawal operationspayments:readPayins and
withdrawal read operationstopups:adminTop-ups operationstopups:readTop-ups read
operationscredit_fundings:readCredit Fundings read
operationssecurities_transfers:readSecurities Transfers read
transferssecurities_transfers:adminSecurities Transfers
operationsreports:readRead reportsreports:adminCreate reportstaxes:readRead tax
residenciestaxes:adminModify tax residencies and tax
exemptionstransactions:readRead cash and securities
transactionsinstruments:readRead instrumentsfees:adminCreate and read fee
operationsfees:readRead fee operationsportfolios:readRead
portfoliosportfolios:adminModify portfoliosvaluations:readRead
valuationsaccount_liquidations:readRead accounts
liquidationsaccount_liquidations:adminTrigger/read/cancel accounts
liquidationsaccount_returns:readRead accounts
returnsvirtual_cash_balances:adminVirtual cash balancessavings_plans:readRead
savings planssavings_plans:adminCreate/read savings plansprices:readRead
instrument prices,tests:adminTesting related operations

--------------------------------------------------------------------------------

Was this page helpful?



Thank you! Your feedback has been received.
 * REST
 * .NET
 * Java
 * PHP
 * Python
 * Ruby
 * TypeScript
 * Go


 * REST

Table Of Contents
Introduction
Environments
Production
Sandbox
Authorization
oauth-client-credentials (OAuth 2 Client Credentials Grant)

Back to top