Skip to content
API Reference/
/
Retrieve a user report

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Create a user report

Request

Create a user report

Security
oauth-client-credentials
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
Bodyapplication/json
typestringrequired

The type of report must be “ORDER_EX_ANTE_COST”.

Default "ORDER_EX_ANTE_COST"
orderobjectrequired

Order details.

instrument_idstring^[A-Z]{2}[A-Z0-9]{9}[0-9]$required

International securities identification number defined by ISO 6166.

instrument_id_typestringrequired

The type of the ID used in the request.

  • ISIN -
Default "ISIN"
Value"ISIN"
account_idstring(uuid)required

The ID of the account that owns the order.

user_idstring(uuid)required

The ID of the user.

currencystringrequired
Default "EUR"
Value"EUR"
order_typestringrequired

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum"MARKET""LIMIT""STOP"
sidestringrequired

Side of the order.

  • BUY -
  • SELL -
Enum"BUY""SELL"
cash_amountstring^[0-9]{1,9}(\.[0-9]{2})?$
quantitystring^[0-9]{0,63}(\.[0-9]{1,27})?$
limit_pricestring^[0-9]{0,63}(\.[0-9]{1,27})?$
stop_pricestring^[0-9]{0,63}(\.[0-9]{1,27})?$
feesArray of objects

Client fees.

inducementsArray of objects

Client inducements.

curl -i -X POST \
  https://sandbox.upvest.co/reports \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d '{
    "type": "ORDER_EX_ANTE_COST",
    "order": {
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "order_type": "MARKET",
      "side": "BUY",
      "instrument_id": "LU0274208692",
      "instrument_id_type": "ISIN",
      "currency": "EUR",
      "quantity": "15"
    },
    "fees": [
      {
        "type": "TRANSACTION_FEE_BUY",
        "value_type": "ABSOLUTE",
        "cash_amount": "0.80",
        "currency": "EUR"
      },
      {
        "type": "TRANSACTION_FEE_SELL",
        "value_type": "ABSOLUTE",
        "cash_amount": "0.95",
        "currency": "EUR"
      },
      {
        "type": "ANNUAL_AUM_BASED_FEE",
        "value_type": "RELATIVE",
        "bps": "37"
      }
    ],
    "inducements": [
      {
        "value_type": "ABSOLUTE",
        "cash_amount": "0.10",
        "currency": "EUR"
      }
    ]
  }'

Responses

Report

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Report unique identifier.

user_idstring(uuid)required

User unique identifier.

created_atstring(date-time)required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

typestringrequired

The type of report must be “ORDER_EX_ANTE_COST”.

Default "ORDER_EX_ANTE_COST"
substituted_report_idnull or stringrequired
One of:
null
dataobject

Contents of the order ex-ante cost report.

Response
application/json
{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2023-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "ORDER_EX_ANTE_COST",
  "substituted_report_id": null,
  "data": {
    "account": { … },
    "account_group": { … },
    "user": { … },
    "instrument": { … },
    "venue": { … },
    "order": { … },
    "holding_period": { … },
    "total_cost": { … },
    "product_cost": { … },
    "service_cost": { … },
    "third_party_payments": { … },
    "return_impact": { … }
  }
}

Retrieve a user report

Request

Retrieve a user report

Security
oauth-client-credentials
Path
report_idstring(uuid)required

Report unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
acceptstring

Report format

Default application/json
Enum"application/json""application/pdf"
curl -i -X GET \
  'https://sandbox.upvest.co/reports/{report_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

Report

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Body
Any of:
idstring(uuid)required

Report unique identifier.

user_idstring(uuid)required

User unique identifier.

created_atstring(date-time)required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

typestringrequired

Report type

  • ACCOUNT_CLOSING - Securities account closure
  • ACCOUNT_OPENING - Securities account opening
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • BUY_ORDER - Buy order
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)
  • CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • EX_POST_COST - Ex-post cost report
  • FUND_COMMUNICATION - Generic fund communication
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • GENERIC_COMMUNICATION - Generic communication
  • INCOME_DISTRIBUTION - Income distribution report
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • SECURITIES_TRANSFER_INCOMING - Securities are transferred in
  • SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out
  • SELL_ORDER - Sell order
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • TAX_PAYMENT - Tax payment document
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund document (after tax optimization)
Enum"ACCOUNT_CLOSING""ACCOUNT_OPENING""AD_HOC_ACCOUNT_STATEMENT""ANNUAL_ACCOUNT_STATEMENT""ANNUAL_INCOME_STATEMENT""ANNUAL_TAX_STATEMENT""BANK_ACCOUNT_CONNECTED""BUY_ORDER""CANCELLED_ORDER""CORPORATE_ACTION_CASH_TRANSACTION"
substituted_report_idnull or stringrequired
One of:
null
dataobject

Contents of the report.

Response
{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "BUY_ORDER",
  "substituted_report_id": null,
  "data": {
    "account": { … }
  }
}

User reports eventsWebhook

Request

User reports events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

typestringrequired

Event type

Default "REPORT.CREATED"
Value"REPORT.CREATED"
objectobjectrequired
Any of:
idstring(uuid)required

Report unique identifier.

user_idstring(uuid)required

User unique identifier.

created_atstring(date-time)required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

typestringrequired

Report type

  • ACCOUNT_CLOSING - Securities account closure
  • ACCOUNT_OPENING - Securities account opening
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • BUY_ORDER - Buy order
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • CORPORATE_ACTION_CASH_TRANSACTION - cash transaction document (after corporate action)
  • CORPORATE_ACTION_SECURITY_TRANSACTION - security transaction document (after corporate action)
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • EX_POST_COST - Ex-post cost report
  • FUND_COMMUNICATION - Generic fund communication
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • GENERIC_COMMUNICATION - Generic communication
  • INCOME_DISTRIBUTION - Income distribution report
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • QUARTERLY_ACCOUNT_STATEMENT - Quarterly account statement
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • SECURITIES_TRANSFER_INCOMING - Securities are transferred in
  • SECURITIES_TRANSFER_OUTGOING - Securities are being transferred out
  • SELL_ORDER - Sell order
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • TAX_PAYMENT - Tax payment document
  • TAX_PREPAYMENT_DE - German tax prepayment (Vorabpauschale)
  • TAX_REFUND - Tax refund document (after tax optimization)
Enum"ACCOUNT_CLOSING""ACCOUNT_OPENING""AD_HOC_ACCOUNT_STATEMENT""ANNUAL_ACCOUNT_STATEMENT""ANNUAL_INCOME_STATEMENT""ANNUAL_TAX_STATEMENT""BANK_ACCOUNT_CONNECTED""BUY_ORDER""CANCELLED_ORDER""CORPORATE_ACTION_CASH_TRANSACTION"
substituted_report_idnull or stringrequired
One of:
null
dataobject

Contents of the report.

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "REPORT.CREATED",
  "object": {
    "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
    "created_at": "2020-08-24T14:15:22Z",
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "type": "CORPORATE_ACTION_CASH_TRANSACTION",
    "substituted_report_id": null,
    "data": { … }
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Responses

Request has been processed successfully.

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations