{ "openapi": "3.0.4", "info": { "title": "WealthArc External API", "description": "The WealthArc External API allows clients to securely access financial data, manage portfolios.", "termsOfService": "https://www.wealthdatabox.com", "contact": { "name": "WealthArc API Support", "url": "https://www.wealthdatabox.com", "email": "api-support@wealthdatabox.com" }, "license": { "name": "Proprietary License", "url": "https://www.wealthdatabox.com" }, "version": "1.0" }, "servers": [ { "url": "https://api.wealthdatabox.com/", "description": "Production Environment" }, { "url": "https://api.sandbox.wealthdatabox.com/", "description": "Sandbox Environment" } ], "paths": { "/v1/Assets": { "get": { "tags": [ "Assets" ], "summary": "Get all assets", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Assets?$select=id, name, iban, currency\r\n\r\nFiltering data set: /Assets?$filter=name eq 'CASH ACCOUNT IN CHF' or name eq 'CASH ACCOUNT IN USD'", "operationId": "GetAssets", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssetODataPagedResult" } } } } } } }, "/v1/Assets/WealthArc.CashAccount": { "get": { "tags": [ "Assets" ], "summary": "Get all cash accounts", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Assets/WealthArc.CashAccount?$select=id, name, iban, currency\r\n\r\nFiltering data set: /Assets/WealthArc.CashAccount?$filter=name eq 'CASH ACCOUNT IN CHF' or name eq 'CASH ACCOUNT IN USD'", "operationId": "GetCashAccounts", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashAccountODataPagedResult" } } } } } } }, "/v1/Assets/WealthArc.Instrument": { "get": { "tags": [ "Assets" ], "summary": "Get all instruments", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Assets/WealthArc.Instrument?$select=id, name, isin, currency\r\n\r\nFiltering data set: /Assets/WealthArc.Instrument?$filter=name eq 'Restaurant Brands'", "operationId": "GetInstruments", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InstrumentODataPagedResult" } } } } } } }, "/v1/Assets/WealthArc.Crypto": { "get": { "tags": [ "Assets" ], "summary": "Get all crypto assets", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Assets/WealthArc.Crypto?$select=id, name, cryptoSymbol, currency\r\n\r\nFiltering data set: /Assets/WealthArc.Crypto?$filter=cryptoSymbol eq 'BTC'", "operationId": "GetCryptos", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CryptoODataPagedResult" } } } } } } }, "/v1/Assets/{key}": { "get": { "tags": [ "Assets" ], "summary": "Get asset by id", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\nSelecting data set: /Assets/{key}?$select=id, name, iban, currency\r\n", "operationId": "GetAsset", "parameters": [ { "name": "key", "in": "path", "description": "Asset unique id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Asset" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Asset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "404": { "description": "Not Found" } } } }, "/v1/Portfolios": { "get": { "tags": [ "Portfolios" ], "summary": "Get all portfolios", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Portfolios?$select=id, name, currency\r\n\r\nFiltering data set: /Portfolios?$filter=name eq 'Test Portfolio'", "operationId": "GetPortfolios", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortfolioODataPagedResult" } } } } } } }, "/v1/Portfolios/{key}": { "get": { "tags": [ "Portfolios" ], "summary": "Get portfolio by id", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Portfolios/{key}?$select=id, name, currency\r\n", "operationId": "GetPortfolio", "parameters": [ { "name": "key", "in": "path", "description": "Portfolio unique id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Portfolio" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Portfolio" } } } }, "404": { "description": "Not Found" } } } }, "/v1/PortfoliosDailyMetrics": { "get": { "tags": [ "PortfoliosDailyMetrics" ], "summary": "Get all portfolio daily metrics", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /PortfoliosDailyMetrics?$select=id, statementDate\r\n\r\nFiltering data set: /PortfoliosDailyMetrics?$filter=id eq 12", "operationId": "GetPortfolioDailyMetricss", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetricsODataPagedResult" } } } } } } }, "/v1/PortfoliosDailyMetrics/{key}": { "get": { "tags": [ "PortfoliosDailyMetrics" ], "summary": "Get portfolio daily metrics by id", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /PortfoliosDailyMetrics/{key}?$select=id\r\n", "operationId": "GetPortfolioDailyMetrics", "parameters": [ { "name": "key", "in": "path", "description": "Portfolio daily metrics unique id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } } } }, "404": { "description": "Not Found" } } } }, "/v1/Positions": { "get": { "tags": [ "Positions" ], "summary": "Get all positions", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Positions?$select=portfolioId, instrumentId, statementDate \r\n\r\nFiltering data set: /Positions?$filter=portfolioId eq 20146", "operationId": "GetPositions", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PositionODataPagedResult" } } } } } } }, "/v1/Positions/{key}": { "get": { "tags": [ "Positions" ], "summary": "Get position by id", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Positions/{key}?$select=portfolioId, instrumentId, statementDate, quantity, price\r\n", "operationId": "GetPortfolioDailyMetrics", "parameters": [ { "name": "key", "in": "path", "description": "Position id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortfolioDailyMetrics" } } } } } } }, "/v1/Transactions": { "get": { "tags": [ "Transactions" ], "summary": "Get all transactions", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Transactions?$select=id, instrumentId\r\n\r\nFiltering data set: /Transactions?$filter=portfolioId eq 20146", "operationId": "GetTransactions", "parameters": [ { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter the results using OData syntax.", "schema": { "pattern": "^.+\\s(eq|ne|gt|lt|ge|le|and|or)\\s.+$", "type": "string" } }, { "name": "orderby", "in": "query", "description": "Order the results using OData syntax.", "schema": { "pattern": "^[a-zA-Z_]+\\s(asc|desc)(,\\s*[a-zA-Z_]+\\s(asc|desc))*$", "type": "string" } }, { "name": "top", "in": "query", "description": "Maximum number of results to return.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "Number of results to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Whether to include a count of results.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionODataPagedResult" } } } } } } }, "/v1/Transactions/{key}": { "get": { "tags": [ "Transactions" ], "summary": "Get transaction by id", "description": "This endpoint uses OData. All operators are supported.\r\n\r\nTo make it as fast as possible, please select the smallest required data set.\r\n\r\nExamples:\r\n\r\nSelecting data set: /Transactions/{key}?$select=id, portfolioId, instrumentId, Quantity\r\n", "operationId": "GetTransaction", "parameters": [ { "name": "key", "in": "path", "description": "Transaction id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string" } }, { "name": "expand", "in": "query", "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Transaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "Asset": { "required": [ "@odata.type" ], "type": "object", "properties": { "@odata.type": { "type": "string" }, "id": { "type": "integer", "description": "Id of an Asset", "format": "int32", "example": 25237 }, "name": { "type": "string", "description": "Asset name", "nullable": true, "example": "Example Asset Name" }, "currency": { "type": "string", "description": "ISO-4217 compliant currency code", "nullable": true, "example": "USD" }, "assetClass": { "type": "string", "description": "Asset Class", "nullable": true, "example": "Deposits, Money Market and Fixed Income" }, "assetSubClass": { "type": "string", "description": "Asset Subclass", "nullable": true, "example": "Cash" }, "investmentType": { "type": "string", "description": "Investment Type", "nullable": true, "example": "Loan" }, "description": { "type": "string", "description": "Cash account description", "nullable": true, "example": "Sample Description" }, "quotationFactor": { "type": "number", "description": "Cash account quotation factor", "format": "double", "nullable": true, "example": 1 }, "interestRate": { "type": "number", "description": "Interest Rate", "format": "double", "nullable": true, "example": 1.3 }, "maturityDate": { "type": "string", "description": "yyyy-MM-dd format maturity date", "format": "date", "nullable": true, "example": "2018-03-02" }, "riskScore": { "maximum": 10, "minimum": 1, "type": "integer", "description": "Risk score in 1-10 scale", "format": "int32", "nullable": true, "example": 3 } }, "additionalProperties": false, "description": "Entity representing asset", "discriminator": { "propertyName": "@odata.type", "mapping": { "#WealthArc.CashAccount": "#/components/schemas/CashAccount", "#WealthArc.Instrument": "#/components/schemas/Instrument", "#WealthArc.Crypto": "#/components/schemas/Crypto" } } }, "AssetODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CashAccount" }, { "$ref": "#/components/schemas/Instrument" }, { "$ref": "#/components/schemas/Crypto" } ], "description": "Entity representing asset" }, "nullable": true } }, "additionalProperties": false }, "CashAccount": { "allOf": [ { "$ref": "#/components/schemas/Asset" }, { "type": "object", "properties": { "iban": { "type": "string", "description": "Cash account IBAN number", "nullable": true, "example": "CH5604835012345678009" } }, "additionalProperties": false } ], "description": "Entity representing a cash account" }, "CashAccountODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/CashAccount" }, "nullable": true } }, "additionalProperties": false }, "Crypto": { "allOf": [ { "$ref": "#/components/schemas/Asset" }, { "type": "object", "properties": { "cryptoSymbol": { "type": "string", "description": "Crypto asset symbol", "nullable": true, "example": "BTC" }, "provider": { "type": "string", "description": "Crypto asset provider", "nullable": true, "example": "Coinbase" }, "blockchain": { "type": "string", "description": "Crypto asset blockchain", "nullable": true, "example": "Bitcoin" }, "address": { "type": "string", "description": "Crypto wallet address", "nullable": true, "example": "bc1qar0srr7xfkvy5l643lydnw9re59gtzzwf5mdq" }, "temperature": { "type": "string", "description": "Crypto custody temperature", "nullable": true, "example": "Cold" }, "selfcustody": { "type": "boolean", "description": "Flag indicating if the crypto asset is self-custodied", "nullable": true, "example": true } }, "additionalProperties": false } ], "description": "Entity representing a crypto asset" }, "CryptoODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Crypto" }, "nullable": true } }, "additionalProperties": false }, "CustodianPortfolioPerformance": { "required": [ "createdAt", "modifiedAt", "statementDate" ], "type": "object", "properties": { "portfolioId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 30825 }, "statementDate": { "type": "string", "description": "Statement date", "format": "date", "example": "2024-01-26" }, "portfolioCurrency": { "type": "string", "description": "Portfolio Currency", "nullable": true, "example": "CHF" }, "ytdCalculationStartDate": { "type": "string", "description": "Start of YTD calculation", "format": "date", "nullable": true, "example": "2024-01-26" }, "ytdGross": { "type": "number", "description": "YTD Performance Gross (delivered by Custodian Bank)", "format": "double", "nullable": true, "example": -0.00612063 }, "ytdNet": { "type": "number", "description": "YTD Performance Net (delivered by Custodian Bank)", "format": "double", "nullable": true, "example": -0.00612063 }, "mtdGross": { "type": "number", "description": "MTD Performance Gross (delivered by Custodian Bank)", "format": "double", "nullable": true, "example": -0.00532612 }, "mtdNet": { "type": "number", "description": "MTD Performance Net (delivered by Custodian Bank)", "format": "double", "nullable": true, "example": -0.00532612 }, "createdAt": { "type": "string", "description": "Creation date", "format": "date-time", "example": "2024-01-26 01:30:20" }, "modifiedAt": { "type": "string", "description": "Last modification date", "format": "date-time", "example": "2024-01-26 11:30:45" } }, "additionalProperties": false }, "Instrument": { "allOf": [ { "$ref": "#/components/schemas/Asset" }, { "type": "object", "properties": { "isin": { "type": "string", "description": "ISIN", "nullable": true, "example": "US46434G8226" }, "valor": { "type": "string", "description": "VALOR", "nullable": true, "example": "034388865" }, "region": { "type": "string", "description": "Region", "nullable": true, "example": "CH" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 compliant code", "nullable": true, "example": "CH" }, "sector": { "type": "string", "description": "Sector according to GICS", "nullable": true, "example": "Financials" }, "industryGroup": { "type": "string", "description": "Industry group according to GICS", "nullable": true, "example": "Diversified Financials" }, "industry": { "type": "string", "description": "Industry according to GICS", "nullable": true, "example": "Capital Markets" }, "subIndustry": { "type": "string", "description": "Sub-industry according to GICS", "nullable": true, "example": "Diversified Capital Markets" }, "instrumentInfo": { "type": "string", "description": "Instrument additional information", "nullable": true, "example": "Sample Additional Info" }, "wkn": { "type": "string", "description": "WKN", "nullable": true, "example": "860853" }, "cusip": { "type": "string", "description": "CUSIP", "nullable": true, "example": "594918104" }, "sedol": { "type": "string", "description": "SEDOL", "nullable": true, "example": "0540528.1" }, "ric": { "type": "string", "description": "RIC", "nullable": true, "example": "IBM.N" }, "figi": { "type": "string", "description": "FIGI", "nullable": true, "example": "BBG000BLNQ16" }, "optionType": { "type": "string", "description": "Option Type if applicable", "nullable": true, "example": "PUT" }, "underlyingInstrument": { "type": "string", "description": "Underlying Instrument for options", "nullable": true, "example": "Apple" }, "underlyingInstrumentIsin": { "type": "string", "description": "Underlying Instrument ISIN for options", "nullable": true, "example": "US46434G8226" }, "strikePrice": { "type": "number", "description": "StrikePrice for options", "format": "double", "nullable": true, "example": 410 }, "multiplier": { "type": "number", "description": "Multiplier for options", "format": "double", "nullable": true, "example": 1 }, "instrumentIssuer": { "type": "string", "description": "Instrument Issuer", "nullable": true, "example": "iShares Japan" }, "suitabilityScore": { "type": "integer", "description": "Suitability Score", "format": "int32", "nullable": true, "example": 3 }, "appropriatenessScore": { "type": "integer", "description": "Appropriateness Score", "format": "int32", "nullable": true, "example": 5 }, "priceSourceForManualPortfolio": { "type": "string", "description": "Price source selected for manual portfolios", "nullable": true, "example": "UBS" } }, "additionalProperties": false } ], "description": "Entity representing an instrument" }, "InstrumentODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Instrument" }, "nullable": true } }, "additionalProperties": false }, "MandateType": { "enum": [ "Advisory", "Discretionary", "ExecutionOnly", "OffManagement", "ReadOnly", "Administrative" ], "type": "string" }, "Portfolio": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 30825 }, "name": { "type": "string", "description": "Portfolio name", "nullable": true, "example": "Yann Sommer" }, "shortName": { "type": "string", "description": "Portfolio short name", "nullable": true, "example": "Yann S." }, "custodianId": { "type": "string", "description": "Internal identifier of a Portfolio used by Custodian", "nullable": true, "example": "500273.43" }, "custodian": { "type": "string", "description": "Custodian", "nullable": true, "example": "LODH" }, "currency": { "type": "string", "description": "Portfolio currency (original from a custodian)", "nullable": true, "example": "EUR" }, "wealthArcCurrency": { "type": "string", "description": "WealthArc portfolio currency", "nullable": true, "example": "CHF" }, "description": { "type": "string", "description": "Portfolio description", "nullable": true, "example": "Equity portfolio" }, "additionalInfo": { "type": "string", "description": "Portfolio additional info", "nullable": true, "example": "No Invoicing" }, "isActive": { "type": "boolean", "description": "Flag confirming if a portfolio is active", "example": true }, "inceptionDate": { "type": "string", "description": "Inception date of a portfolio", "format": "date", "nullable": true, "example": "2024-01-26" }, "endDate": { "type": "string", "description": "End Date of a portfolio", "format": "date", "nullable": true, "example": "2024-01-26" }, "relationshipManager": { "type": "string", "description": "Relationship manager", "nullable": true, "example": "David Gasser" }, "portfolioManager": { "type": "string", "description": "Portfolio manager", "nullable": true, "example": "David Gasser" }, "assistant": { "type": "string", "description": "Assistant", "nullable": true, "example": "Michael Schmit" }, "businessEntity": { "type": "string", "description": "Business Entity", "nullable": true, "example": "Point A1 LODH" }, "branch": { "type": "string", "description": "Branch", "nullable": true, "example": "Zürich" }, "profitCenter": { "type": "string", "description": "Profit center", "nullable": true, "example": "Switzerland" }, "parentPortfolioId": { "type": "integer", "description": "Portfolio Id of a parent from consolidation", "format": "int32", "nullable": true, "example": 30820 }, "investmentGroup": { "type": "string", "description": "Investment group", "nullable": true, "example": "Growth Equity" }, "modelPortfolioId": { "type": "integer", "description": "Portfolio Id of an assigned model portfolio", "format": "int32", "nullable": true, "example": 30827 }, "mandateType": { "allOf": [ { "$ref": "#/components/schemas/MandateType" } ], "description": "Mandate type", "nullable": true, "example": "Advisory" }, "isManual": { "type": "boolean", "description": "Flag indicating if it requires simulation since this is a manual portfolio", "example": false }, "type": { "allOf": [ { "$ref": "#/components/schemas/PortfolioType" } ], "description": "Type of Portfolio", "nullable": true, "example": "Client" } }, "additionalProperties": false }, "PortfolioAum": { "required": [ "createdAt", "modifiedAt", "statementDate" ], "type": "object", "properties": { "portfolioDailyMetricsId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 30825 }, "statementDate": { "type": "string", "description": "Statement Date", "format": "date", "example": "2024-01-26" }, "netAmount": { "type": "number", "description": "Net AuM Amount (loans included)", "format": "double", "example": 3277457.8 }, "grossAmount": { "type": "number", "description": "Gross AuM Amount (loans excluded)", "format": "double", "example": 3277457.8 }, "currency": { "type": "string", "description": "AuM Currency", "nullable": true, "example": "CHF" }, "createdAt": { "type": "string", "description": "AuM creation date", "format": "date-time", "example": "2024-01-26 01:30:20" }, "modifiedAt": { "type": "string", "description": "AuM last modification date", "format": "date-time", "example": "2024-01-26 11:30:45" } }, "additionalProperties": false, "description": "Portfolio AUM" }, "PortfolioDailyMetrics": { "required": [ "statementDate" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of a PortfolioDailyMetrics", "format": "int32", "example": 301246 }, "portfolioId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 30825 }, "statementDate": { "type": "string", "description": "Statement date", "format": "date", "example": "2024-01-05" }, "overdraftsCount": { "type": "integer", "description": "Number of cash accounts with negative balance", "format": "int32", "nullable": true, "example": 3 }, "custodianPerformances": { "type": "array", "items": { "$ref": "#/components/schemas/CustodianPortfolioPerformance" }, "nullable": true }, "aums": { "type": "array", "items": { "$ref": "#/components/schemas/PortfolioAum" }, "nullable": true }, "performances": { "type": "array", "items": { "$ref": "#/components/schemas/PortfolioPerformance" }, "nullable": true } }, "additionalProperties": false }, "PortfolioDailyMetricsODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/PortfolioDailyMetrics" }, "nullable": true } }, "additionalProperties": false }, "PortfolioODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Portfolio" }, "nullable": true } }, "additionalProperties": false }, "PortfolioPerformance": { "required": [ "createdAt", "modifiedAt", "statementDate" ], "type": "object", "properties": { "portfolioId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 30825 }, "statementDate": { "type": "string", "description": "Statement date", "format": "date", "example": "2024-01-26" }, "ytdCalculationStartDate": { "type": "string", "description": "Start of YTD calculation", "format": "date", "nullable": true, "example": "2024-01-26" }, "ytdGross": { "type": "number", "description": "YTD Performance Gross WA Portfolio Currency (WA methodology)", "format": "double", "nullable": true, "example": -0.00612063 }, "ytdNet": { "type": "number", "description": "YTD Performance Net WA Portfolio Currency (WA methodology)", "format": "double", "nullable": true, "example": -0.00612063 }, "mtdGross": { "type": "number", "description": "MTD Performance Gross WA Portfolio Currency (WA methodology)", "format": "double", "nullable": true, "example": -0.00532612 }, "mtdNet": { "type": "number", "description": "MTD Performance Net WA Portfolio Currency (WA methodology)", "format": "double", "nullable": true, "example": -0.00532612 }, "createdAt": { "type": "string", "description": "Performance creation date", "format": "date-time", "example": "2024-01-26 01:30:20" }, "modifiedAt": { "type": "string", "description": "Performance last modification date", "format": "date-time", "example": "2024-01-26 11:30:45" } }, "additionalProperties": false, "description": "Portfolio Performance" }, "PortfolioType": { "enum": [ "Client", "Model", "NonFinancial", "Consolidated", "External", "Fund", "Benchmark", "Subaccount" ], "type": "string" }, "Position": { "required": [ "createdAt", "modifiedAt", "statementDate" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of a Position", "format": "int32", "example": 601345 }, "portfolioId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 25122 }, "assetId": { "type": "integer", "description": "Id of an Asset", "format": "int32", "example": 25829 }, "statementDate": { "type": "string", "description": "Statement Date", "format": "date", "example": "2024-01-26" }, "quantity": { "type": "number", "description": "Position quantity", "format": "double", "example": 50 }, "price": { "type": "number", "description": "Last available price", "format": "double", "nullable": true, "example": 1869 }, "priceCurrency": { "type": "string", "description": "Price currency", "nullable": true, "example": "USD" }, "valueDate": { "type": "string", "description": "Value date", "format": "date", "nullable": true, "example": "2024-01-26" }, "priceSource": { "type": "string", "description": "Price source name", "nullable": true, "example": "LODH" }, "unitCostInPriceCurrency": { "type": "number", "description": "Unit cost in price currency", "format": "double", "nullable": true }, "allocation": { "type": "number", "description": "Allocation", "format": "double", "nullable": true, "example": 0.1321 }, "portfolioCurrency": { "type": "string", "description": "Portfolio Currency", "nullable": true, "example": "EUR" }, "bookCostInPortfolioCurrency": { "type": "number", "description": "Book cost in Portfolio currency", "format": "double", "nullable": true, "example": 48499.16 }, "fxRate": { "type": "number", "description": "FX rate", "format": "double", "nullable": true, "example": 0.9561 }, "fxRateSource": { "type": "string", "description": "FX rate source", "nullable": true, "example": "LODH" }, "accruedInterestInPriceCurrency": { "type": "number", "description": "Accrued interests in price currency", "format": "double", "nullable": true, "example": 0 }, "accruedInterestInPortfolioCurrency": { "type": "number", "description": "Accrued interests in portfolio currency", "format": "double", "nullable": true, "example": 0 }, "cumulativeCashflowInPriceCurrency": { "type": "number", "description": "Cumulative cashflow in price currency", "format": "double", "nullable": true, "example": 150.7 }, "createdAt": { "type": "string", "description": "Position creation date", "format": "date-time", "example": "2024-01-26 00:00:00" }, "modifiedAt": { "type": "string", "description": "Position last modification date", "format": "date-time", "example": "2024-01-26 12:30:45" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/PositionValue" }, "description": "Position values in supported currencies", "nullable": true }, "pnl": { "type": "array", "items": { "$ref": "#/components/schemas/PositionPnl" }, "nullable": true }, "performances": { "type": "array", "items": { "$ref": "#/components/schemas/PositionPerformance" }, "nullable": true } }, "additionalProperties": false }, "PositionODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Position" }, "nullable": true } }, "additionalProperties": false }, "PositionPerformance": { "required": [ "createdAt", "modifiedAt" ], "type": "object", "properties": { "positionId": { "type": "integer", "description": "Id of a Position", "format": "int32", "example": 25122 }, "ytdMarket": { "type": "number", "description": "YTD Market in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.00612063 }, "mtdMarket": { "type": "number", "description": "MTD Market in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.00612063 }, "ytdCurrencyEffect": { "type": "number", "description": "YTD Currency Effect in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.00532612 }, "mtdCurrencyEffect": { "type": "number", "description": "MTD Currency Effect in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.00532612 }, "ytdPerformance": { "type": "number", "description": "YTD Performance in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.01141415 }, "mtdPerformance": { "type": "number", "description": "MTD Performance in Portfolio CCY (WA methodology)", "format": "double", "nullable": true, "example": -0.01141415 }, "createdAt": { "type": "string", "description": "Performance creation date", "format": "date-time", "example": "2024-01-26 01:30:20" }, "modifiedAt": { "type": "string", "description": "Performance last modification date", "format": "date-time", "example": "2024-01-26 11:30:45" } }, "additionalProperties": false }, "PositionPnl": { "required": [ "createdAt", "modifiedAt" ], "type": "object", "properties": { "positionId": { "type": "integer", "description": "Id of a Position", "format": "int32", "example": 25122 }, "portfolioId": { "type": "integer", "description": "Id of a Portfolio", "format": "int32", "example": 25122 }, "totalPnL": { "type": "number", "description": "Total Profit and Loss", "format": "double", "nullable": true, "example": 46023.645 }, "totalPnLPercentage": { "type": "number", "description": "Total Profit and Loss as a percentage of a position value", "format": "double", "nullable": true, "example": 0.94895756 }, "marketPnL": { "type": "number", "description": "Market Profit and Loss", "format": "double", "nullable": true, "example": 42812.46 }, "marketPnLPercentage": { "type": "number", "description": "Market Profit and Loss as a percentage of a position value", "format": "double", "nullable": true, "example": 0.8454688 }, "pnLCurrencyEffect": { "type": "number", "description": "Currency effect taken into account", "format": "double", "nullable": true, "example": 0.103488795 }, "totalPnLWithCashflow": { "type": "number", "description": "Total Profit and Loss including cashflows", "format": "double", "nullable": true, "example": 46023.645 }, "totalPnLWithCashflowPercentage": { "type": "number", "description": "Total Profit and Loss including cashflows as a percentage of a position value", "format": "double", "nullable": true, "example": 0.94895756 }, "cumulativeCashflow": { "type": "number", "description": "Cumulative Cashflow", "format": "double", "nullable": true }, "createdAt": { "type": "string", "description": "Profit and Loss creation date", "format": "date-time", "example": "2024-01-26 00:00:00" }, "modifiedAt": { "type": "string", "description": "Profit and Loss last modification date", "format": "date-time", "example": "2024-01-26 12:30:45" } }, "additionalProperties": false }, "PositionValue": { "required": [ "createdAt", "modifiedAt" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of a PositionValue", "format": "int32" }, "positionId": { "type": "integer", "description": "Id of a position", "format": "int32", "example": 495682 }, "amount": { "type": "number", "description": "Position value amount", "format": "double", "nullable": true, "example": 406091.7 }, "currency": { "type": "string", "description": "ISO4217 compliant format", "nullable": true, "example": "USD" }, "fxRateDate": { "type": "string", "description": "Applied FX Rate date", "format": "datetime", "nullable": true, "example": "2018-08-21" }, "fxRateFrom": { "type": "string", "description": "Currency which value is converted from", "nullable": true, "example": "GBP" }, "fxRateTo": { "type": "string", "description": "Currency to which value is converted", "nullable": true, "example": "CHF" }, "fxRate": { "type": "number", "description": "FX Rate", "format": "double", "nullable": true, "example": 1.12572 }, "fxRateSource": { "type": "string", "description": "Fx Rate Source", "nullable": true, "example": "xignite" }, "createdAt": { "type": "string", "description": "Position value creation date", "format": "date-time", "example": "2024-01-26 00:00:00" }, "modifiedAt": { "type": "string", "description": "Position value last modification date", "format": "date-time", "example": "2024-01-26 12:30:45" } }, "additionalProperties": false }, "Transaction": { "required": [ "transactionDate" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of a transaction", "format": "int32", "example": 601345 }, "portfolioId": { "type": "integer", "description": "Id of a portfolio", "format": "int32", "example": 25122 }, "assetId": { "type": "integer", "description": "Id of an asset", "format": "int32", "example": 25829 }, "type": { "allOf": [ { "$ref": "#/components/schemas/TransactionType" } ], "description": "Transaction type", "example": "AssetTransfer" }, "description": { "type": "string", "description": "Description of a transaction", "nullable": true, "example": "Stock transaction without cash" }, "transactionDate": { "type": "string", "description": "Transaction date", "format": "date", "example": "2018-08-21" }, "tradeDate": { "type": "string", "description": "Trade date", "format": "date", "nullable": true, "example": "2018-08-21" }, "valueDate": { "type": "string", "description": "Value date", "format": "date", "nullable": true, "example": "2018-08-21" }, "quantity": { "type": "number", "description": "Quantity of a transaction", "format": "double", "nullable": true, "example": 946 }, "price": { "type": "number", "description": "Price used for a transaction", "format": "double", "nullable": true, "example": 145.844 }, "priceCurrency": { "type": "string", "description": "Price currency", "nullable": true, "example": "USD" }, "portfolioCurrency": { "type": "string", "description": "Portfolio currency", "nullable": true, "example": "EUR" }, "fxRate": { "type": "number", "description": "FX rate", "format": "double", "nullable": true, "example": 0.8681309 }, "fxRateSource": { "type": "string", "description": "FX rate source", "nullable": true, "example": "LODH" }, "externalOrderId": { "type": "string", "description": "Order Id of a transaction that comes from a custodian", "nullable": true, "example": "41REF.9730137KN1607053" }, "referencedInstrumentId": { "type": "integer", "description": "Technical ID of reference Instrument", "format": "int32", "nullable": true }, "referencedInstrumentQuantity": { "type": "number", "description": "Quantity of referenced Instrument", "format": "double", "nullable": true }, "interest": { "type": "number", "description": "Interest", "format": "double", "nullable": true, "example": 0.0138 }, "isReversal": { "type": "boolean", "description": "Flag confirming if a transaction is a reversal", "nullable": true, "example": false }, "isRiskIncreased": { "type": "boolean", "description": "Flag confirming if a transaction is high risk", "nullable": true, "example": true }, "createdAt": { "type": "string", "description": "Date when transaction was created", "format": "date-time", "nullable": true, "example": "true" }, "modifiedAt": { "type": "string", "description": "Date when transaction was modified", "format": "date-time", "nullable": true, "example": "true" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionValue" }, "description": "Transaction values in supported currencies", "nullable": true } }, "additionalProperties": false }, "TransactionODataPagedResult": { "required": [ "@odata.context", "value" ], "type": "object", "properties": { "@odata.context": { "type": "string", "nullable": true }, "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" }, "nullable": true } }, "additionalProperties": false }, "TransactionType": { "enum": [ "Unclassified", "Buy", "Sell", "Income", "FxTrade", "Fees", "DepositWithdrawal", "Tax", "Subscription", "Redemption", "OperationalFees", "CorporateAction", "InternalTransfer", "Other", "AssetTransfer", "Expense", "OpenDeposit", "CloseDeposit", "Expiry", "Call", "Conversion", "WithholdingTax", "Interest", "Dividend", "Coupon", "BankFee", "ManagementFee", "PerformanceFee", "OpenLoan", "CloseLoan", "FxSpot", "Exchange", "Merger", "Split", "SpinOff", "CashInLieu", "FxForward", "Cancellation", "Commission", "StampDuty", "MarginPayment", "Assimilation", "BonusIssue", "CapitalDecrease", "CapitalIncrease", "Delisting", "NameChange", "PartialRedemption", "ReverseSplit", "OpenLongPosition", "OpenShortPosition" ], "type": "string" }, "TransactionValue": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of a TransactionValue", "format": "uuid", "example": "4459df0d-a90b-4c39-aee9-08db1e01c877" }, "transactionId": { "type": "integer", "description": "Id of a transaction", "format": "int32", "example": 601345 }, "amount": { "type": "number", "description": "Value", "format": "double", "nullable": true, "example": 2450 }, "currency": { "type": "string", "description": "ISO4217 compliant format", "nullable": true, "example": "USD" }, "fxRateDate": { "type": "string", "description": "Applied FX Rate date", "format": "datetime", "nullable": true, "example": "2018-08-21" }, "fxRateFrom": { "type": "string", "description": "Currency which value is converted from", "nullable": true, "example": "GBP" }, "fxRateTo": { "type": "string", "description": "Currency to which value is converted", "nullable": true, "example": "CHF" }, "fxRate": { "type": "number", "description": "FX Rate", "format": "double", "nullable": true, "example": 1.12572 }, "fxRateSource": { "type": "string", "description": "Fx Rate Source", "nullable": true, "example": "xignite" }, "createdAt": { "type": "string", "description": "Date when transaction value was created", "format": "date-time", "nullable": true, "example": "true" }, "modifiedAt": { "type": "string", "description": "Date when transaction value was modified", "format": "date-time", "nullable": true, "example": "true" } }, "additionalProperties": false } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "name": "x-api-key", "in": "header" } } }, "security": [ { "ApiKey": [ ] } ], "tags": [ { "name": "Assets", "description": "Controller for managing assets." }, { "name": "Portfolios", "description": "Controller for managing portfolios." }, { "name": "PortfoliosDailyMetrics", "description": "Controller for managing portfolios daily metrics." }, { "name": "Positions", "description": "Controller for managing positions." }, { "name": "Transactions", "description": "Controller for managing transactions." } ] }