API Endpoints
Try Demo

Fetch smallcase investments

get
https://gatewayapi.smallcase.com/v1//engine/user/investments

The API provides the list of all the user smallcase investment details or returns the user investment details for a particular smallcase, provided a particular iscid in query param. Data like the current config of the smallcase, stats, returns, smallcase description, and much more is shared.

If query param "aggregatedData" is provided, the API shares user’s aggregated investment details. “data” object field containing aggregated data would be returned.

<>: This is an ideal data api when you want to display information to a user about the investments that have been made by the user

Path Params
string
required
Defaults to gatewaydemo
Query Params
iscids
array of strings

OPTIONAL | array of iscid (invested smallcase ID). If passed will only fetch the details of the given invested smallcase(s).

iscids
boolean

OPTIONAL | aggregatedData can have the value as "true" . If passed will fetch user’s aggregated investment details.

Headers
string
required
Defaults to gatewayDemo_secret

Required | apiSecret shared for authentication

string
required
Defaults to eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFsbGNhc2VBdXRoSWQiOiI2MzFmYWQwMWQ5ZmU3YmEzNGI2YzBhM2EiLCJleHAiOjE5MDAwMDAwMDB9.-_6ykYyKke4xuKImlYEPTX9fJhLoMU86qMHRX0YY6eA

Required | JWT signed with shared secret & payload for connected user

Responses

Updated 6 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago