Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knownwell portfolios API

The portfolios API from Knownwell — 2 operation(s) for portfolios.

Knownwell portfolios API is one of 9 APIs that Knownwell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include portfolios. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against the base URL https://api.knownwell.com/ci/v1.

2 operations 2 paths 11 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.knownwell.com/ci/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Knownwell portfolios API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

portfolios 2
GET
/v1/portfolios
List Portfolios
list_portfolios_v1_portfolios_get 1 param → 200422
GET
/v1/portfolios/{portfolio_id}
Get Portfolio
get_portfolio_v1_portfolios__portfolio_id__get 3 params → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PortfolioDetailResponse (13 properties), ClientResponse (13 properties), PortfolioResponse (10 properties), ClientMetadata (10 properties). Each schema is shown below with its type and property counts.

PortfolioUser
object
User information for portfolio access.
3 properties 1 required
ClientMetadata
object
Client metadata.
10 properties
ScoreChange
object
Score change over a time period.
3 properties 2 required
ScoreChanges
object
Score changes over different time periods.
2 properties
PortfolioDetailResponse
object
Detailed portfolio response with clients and health metrics.
13 properties 5 required
PortfolioHealthResponse
object
Portfolio health metrics.
5 properties 4 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
PortfolioListResponse
object
Response model for list of portfolios.
3 properties 3 required
PortfolioResponse
object
Response model for portfolio list.
10 properties 4 required
ClientResponse
object
Response model for client data.
13 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knownwell-portfolios-api-openapi.yml Raw ↑

Other APIs Knownwell publishes across the network.

Knownwell api-keys API
Knownwell clients API
Knownwell documentation API
Knownwell health API
Knownwell root API
Knownwell status API
Knownwell streams API
Knownwell topics API