v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Investments

List portfolios

List portfolios.

get/financial-data/v2beta/portfolios

Query parameters

entityIdstring

Example:654d7617-1cd3-46ab-921a-56fd92acf4a4

Include only portfolios associated with the entity identified by this ID.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of portfolios.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "entityId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "affiliationId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "thirdPartyId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "alias": "My Portfolio",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "etag": "version:3"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}