Investor Position

This endpoint allows querying an investor's consolidated position, returning information about their holdings in securities.

---

Request

ENDPOINT

/security/investor/INVESTOR-KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
INVESTOR-KEY	string	Unique investor key (UUID v4).	36

---

Response

STATUS

200

Response Body

{
    "investor_key": "a1a75b66-6f7e-4bcc-9ff5-6f8adf7cae09",
    "investor_name": "Ultimate Cascade",
    "investor_document_number": "31.424.651/0001-32",
    "total_current_amount": 100000.0,
    "investment_list": [
        {
            "current_unit_price": 1.0,
            "current_quantity": 100000,
            "security_key": "42bd7161-5ec1-4f64-ac0c-861d93ffb4c2",
            "contract_number": "0000000027",
            "investment_key": "4b705afb-18cb-4fe5-922a-5eab71c2b558",
            "current_amount": 100000.0
        }
    ]
}

---

Response Body Params

Field	Type	Description
investor_key	string	Unique investor key.
investor_name	string	Investor name.
investor_document_number	string	Investor document number (CNPJ).
total_current_amount	number	Investor's total consolidated amount.
investment_list	array	List of investor's holdings in securities. Investment object

Investment object

Field	Type	Description
current_unit_price	number	Current unit price of the security.
current_quantity	integer	Investor's current quantity of the security.
security_key	string	Unique key of the associated security.
contract_number	string	Contract number of the security.
investment_key	string	Unique key of the investor's investment.
current_amount	number	Current value of the investor's holding.