portfolios

Get Portfolios

Retrieve your portfolios (in UI terms - accounts)

get/portfolios

Request

Base URL
https://api.copper.co/platform
Auth
none declared
TypeScript
https://skmtc.dev/copper-co/apis/copper-platform-api/docs/portfolios/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

portfolioTypesPortfolioType[]

Filter by portfolio types. See details

excludedPortfolioTypesPortfolioType[]

Filter by portfolio types not in. See details

portfolioIdstring

Filter by portfolio id

organizationIdstring

Filter by organization id

isActiveboolean

Filter by is active

isDefiVaultboolean

Filter only DeFi vaults

signingFlowTypestring

Filter by signing enabled signing flow type

offsetstring

Offset for pagination

limitstring

Limit for pagination

Response

Example response

{
  "portfolios": [
    {
      "createdAt": "1617235200000",
      "extra": {
        "exchange": "okex"
      },
      "organizationId": "1fa95ae7-5f74-4258-a4c6-687b39d7941d",
      "portfolioDescription": "My portfolio description",
      "portfolioName": "My portfolio",
      "updatedAt": "1617235200000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.