Changes in the API Specification

Back to the summary

Info

  • Title: Upvest Investment API (TOL operation model)Upvest Investment API

  • Version: 1.4.01.5.0

Added endpoints

DELETE /payments/withdrawals/{withdrawal_id}

See updated API reference

Modified endpoints


GET /accounts/{account_id}/orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (added):
                                                    - execution_flow
                                                (deleted):
                                                    - price
                                                (modified):
                                                    initiation_flow:
                                                        enum:
                                                            (added):
                                                                - UPVEST_OPERATIONS

See updated API reference


POST /orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (added):
                            - execution_flow
                        (deleted):
                            - price
responses:
    (modified):
        "202":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (added):
                                    - execution_flow
                                (deleted):
                                    - price
                                (modified):
                                    initiation_flow:
                                        enum:
                                            (added):
                                                - UPVEST_OPERATIONS

See updated API reference


GET /orders/{order_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (added):
                                    - execution_flow
                                (deleted):
                                    - price
                                (modified):
                                    initiation_flow:
                                        enum:
                                            (added):
                                                - UPVEST_OPERATIONS

See updated API reference


GET /reports/{report_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        oneOf:
                                            (added):
                                                - RevisionSchema[0]
                                        type:
                                            from: object
                                            to: ""
                                        title:
                                            from: Report data.
                                            to: Report data
                                        properties:
                                            (deleted):
                                                - account
                                    type:
                                        enum:
                                            (added):
                                                - EX_POST_COST

See updated API reference


GET /users/{user_id}/reports

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

parameters:
    (modified):
        query:
            type:
                schema:
                    enum:
                        (added):
                            - EX_POST_COST
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    data:
                                                        oneOf:
                                                            (added):
                                                                - RevisionSchema[0]
                                                        type:
                                                            from: object
                                                            to: ""
                                                        title:
                                                            from: Report data.
                                                            to: Report data
                                                        properties:
                                                            (deleted):
                                                                - account
                                                    type:
                                                        enum:
                                                            (added):
                                                                - EX_POST_COST

See updated API reference


GET /users/{user_id}/tax_residencies

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            title:
                                from: Tax residencies
                                to: Tax residency Record
                            required:
                                stringsdiff:
                                    (added):
                                        - status
                                        - created_at
                                        - tax_residencies
                                    (deleted):
                                        - additional_tax_residencies
                                        - tax_residency
                                        - residencies_declared_at
                            properties:
                                (added):
                                    - status
                                    - tax_residencies
                                    - created_at
                                (deleted):
                                    - additional_tax_residencies
                                    - residencies_declared_at
                                    - tax_residency

See updated API reference


POST /users/{user_id}/tax_residencies

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    required:
                        stringsdiff:
                            (added):
                                - tax_residencies
                            (deleted):
                                - residencies_declared_at
                                - tax_residency
                    properties:
                        (added):
                            - tax_residencies
                        (deleted):
                            - tax_residency
                            - additional_tax_residencies
                            - residencies_declared_at
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            title:
                                from: Tax residencies
                                to: Tax residency Record
                            required:
                                stringsdiff:
                                    (added):
                                        - created_at
                                        - tax_residencies
                                        - status
                                    (deleted):
                                        - tax_residency
                                        - residencies_declared_at
                                        - additional_tax_residencies
                            properties:
                                (added):
                                    - created_at
                                    - status
                                    - tax_residencies
                                (deleted):
                                    - additional_tax_residencies
                                    - residencies_declared_at
                                    - tax_residency

See updated API reference


GET /webhooks

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    type:
                                                        items:
                                                            enum:
                                                                (added):
                                                                    - INTRADAY_ACCOUNT_VALUATION

See updated API reference


POST /webhooks

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            type:
                                items:
                                    enum:
                                        (added):
                                            - INTRADAY_ACCOUNT_VALUATION
responses:
    (modified):
        "201":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    type:
                                        items:
                                            enum:
                                                (added):
                                                    - INTRADAY_ACCOUNT_VALUATION

See updated API reference


GET /webhooks/{webhook_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    type:
                                        items:
                                            enum:
                                                (added):
                                                    - INTRADAY_ACCOUNT_VALUATION

See updated API reference


PATCH /webhooks/{webhook_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            type:
                                items:
                                    enum:
                                        (added):
                                            - INTRADAY_ACCOUNT_VALUATION
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    type:
                                        items:
                                            enum:
                                                (added):
                                                    - INTRADAY_ACCOUNT_VALUATION

See updated API reference