Portfolios API (2.0.0)

Download OpenAPI specification:

Public API for managing DVPs. Public routes are GET /, GET /openapi.json, and GET /health. Protected routes are authorized by a dedicated Lambda authorizer that forwards AUTH_TOKEN to GET /me on the stage-appropriate Auth API and validates returned effectiveScopes. Preprod uses https://preprod-auth.pbg.io/me and mainnet uses https://auth.pbg.io/me. GET /portfolios/{portfolio-id} requires portfolios:#read. POST /portfolios requires portfolios:#manage.

System

Get the HTML API documentation

Responses

Get API health

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get the OpenAPI specification

Responses

Response samples

Content type
application/json
{ }

Portfolios

Create a portfolio

Authorizations:
AuthToken
Request Body schema: application/json
required
name
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get a portfolio

Authorizations:
AuthToken
path Parameters
portfolio-id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "oracles": [
    ],
  • "quorum": 0,
  • "cardano": {
    }
}