{"components":{"responses":{"Problem400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"Problem403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"Problem404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Not Found"},"Problem429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}}},"Problem500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"Problem502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Gateway"},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BearerError"}}},"description":"Missing, invalid, expired or revoked access token (RFC 6750)","headers":{"WWW-Authenticate":{"description":"Bearer challenge with resource_metadata, scope and, for a rejected token, error","schema":{"type":"string"}}}}},"schemas":{"BearerError":{"properties":{"error":{"description":"missing_token when no token was sent, otherwise an RFC 6750 error code such as invalid_token","type":"string"},"error_description":{"type":"string"}},"required":["error"],"type":"object"},"Problem":{"properties":{"code":{"enum":["validation_error","not_found","forbidden_scope","capability_required","access_revoked","rate_limited","upstream_error","internal_error"],"type":"string"},"detail":{"type":"string"},"request_id":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"required":["type","title","status","detail","code"],"type":"object"}},"securitySchemes":{"oauth2":{"description":"OAuth 2.1 access token from https://mcp.monitor.modularfinance.com for the resource https://mcp.monitor.modularfinance.com/v1. Authorization server metadata: https://mcp.monitor.modularfinance.com/.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://mcp.monitor.modularfinance.com/oauth/authorize","refreshUrl":"https://mcp.monitor.modularfinance.com/oauth/token","scopes":{"monitor:*":"Every scope the customer's Monitor products allow","monitor:bonds.read":"Bonds: bond holdings and their changes","monitor:crm.read":"Your Monitor CRM: contacts, organizations, meetings, events and targeting lists","monitor:documents.read":"Documents: meeting transcripts and press releases","monitor:estimates.read":"Estimates: analyst reports, estimates, consensus and actuals","monitor:market.read":"Market data: companies, share prices, insider transactions, calendars, block trades, buybacks and short positions","monitor:ownership.read":"Ownership: shareholder registers, holdings and their changes, and owner profiles","monitor:targeting.read":"Investor targeting"},"tokenUrl":"https://mcp.monitor.modularfinance.com/oauth/token"}},"type":"oauth2"}}},"info":{"description":"REST access to Modular Finance Monitor data for the signed-in Monitor user and customer. Every operation is POST /v1/\u003cdomain\u003e/\u003ctool\u003e with the tool arguments as a JSON object body; the same operations are available as MCP tools at /mcp.\n\nAuthenticate with an OAuth 2.1 access token (Authorization: Bearer) from the authorization server at https://mcp.monitor.modularfinance.com (metadata: https://mcp.monitor.modularfinance.com/.well-known/oauth-authorization-server; authorization code with PKCE S256, dynamic client registration). Request it for the resource https://mcp.monitor.modularfinance.com/v1 (RFC 8707 resource parameter). Each operation requires the scope listed in its security requirement; monitor:* grants every scope the customer's Monitor products allow. A missing, invalid or expired token is answered with 401 and a WWW-Authenticate challenge whose resource_metadata points at https://mcp.monitor.modularfinance.com/.well-known/oauth-protected-resource/v1.\n\nPaginated operations return next_cursor; repeat the request with cursor set to it and every other argument unchanged. Errors are RFC 9457 problem details with a stable code: validation_error, not_found, forbidden_scope, capability_required, access_revoked, rate_limited (with Retry-After), upstream_error or internal_error.","title":"Modular Finance Monitor API","version":"2026-11-11T08.26.09-3626ace"},"openapi":"3.1.0","paths":{"/bonds/get_bond_holding_history":{"post":{"description":"Recorded bond holding observations over time (not trades) for owner and company pairs: give company_party_ids together with owner_party_ids or parent_party_ids, optionally between from and to. Requires the Monitor bonds product.","operationId":"get_bond_holding_history","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"bond_ids":{"description":"Restrict to these bond issues; at most 100","items":{"type":"string"},"type":"array"},"company_party_ids":{"description":"Company roots whose bondholders are requested; at most 50. Intersects owner selectors","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of holdings entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"minimum_maturity_date":{"description":"Optional explicit maturity cutoff; omitted includes matured issues","format":"date","type":["string","null"]},"owner_party_ids":{"description":"Owners whose bond portfolios are requested; at most 50","items":{"type":"string"},"type":"array"},"parent_party_ids":{"description":"Select underlying owners of these parents, not parent totals, including those held through their sub-managers (junior parents) at any depth; parent_party_id on each row is the direct parent, which may be a sub-manager. When expanded, a parent without children or sub-managers is returned as its own leaf. At most 50. Cannot combine with owner_party_ids or underlying","items":{"type":"string"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: bond_id (string; eq, in), currency (string; eq, in), isin (string; eq, in), nominal_amount (integer; eq, gt, gte, lt, lte), owner_country (string; eq, in), valid_from (date; eq, gt, gte, lt, lte). sort is a list of {field, desc} on: nominal_amount, share_of_bond_outstanding, share_of_company_debt, valid_from. search is a text match on: bond_name, owner_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["nominal_amount","share_of_bond_outstanding","share_of_company_debt","valid_from"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["bond_id","currency","isin","nominal_amount","owner_country","valid_from"],"type":"string"},"op":{"enum":["eq","gt","gte","in","lt","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"format":"date","type":["string","null"]},"underlying":{"description":"Select underlying holders for company roots; cannot combine with owner or parent selectors","type":"boolean"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"holdings":{"items":{"additionalProperties":false,"properties":{"asset_class":{"enum":["bond"],"type":"string"},"at":{"type":["string","null"]},"bond_id":{"type":"string"},"bond_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"isin":{"type":["string","null"]},"issuer_id":{"type":"string"},"nominal_amount":{"description":"Full units in currency, not market value; null is unknown","type":["integer","null"]},"origin":{"items":{"type":"string"},"type":"array"},"owner_country":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Owner identity shared with equity","type":"string"},"parent_party_id":{"description":"Parent of the underlying owner; never add this child's holding to a parent total","type":["string","null"]},"root_company_party_id":{"description":"Nullable company root; preserve positions without a mapped company","type":["string","null"]},"share_of_bond_outstanding":{"description":"Fraction of this issue's outstanding nominal amount","type":["number","null"]},"share_of_company_debt":{"description":"Fraction of company outstanding debt, using FX at the reference date","type":["number","null"]},"share_of_company_debt_in_currency":{"description":"Fraction of company outstanding debt in this currency; no FX","type":["number","null"]},"valid_from":{"type":["string","null"]}},"required":["asset_class","owner_party_id","parent_party_id","owner_name","owner_country","bond_id","bond_name","isin","issuer_id","root_company_party_id","nominal_amount","currency","share_of_company_debt","share_of_company_debt_in_currency","share_of_bond_outstanding","at","valid_from","origin"],"type":"object"},"type":"array"},"level":{"enum":["default","underlying"],"type":"string"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"items":{"additionalProperties":false,"properties":{"party_id":{"description":"Requested identity this entry describes","type":"string"},"reason":{"type":"string"},"role":{"description":"Requested side. Company plus owner or parent requests list both sides; the paired side is complete only when every root it was paired with is","enum":["company","owner","parent"],"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["party_id","role","state"],"type":"object"},"type":"array"}},"required":["holdings","level","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get bond holding history"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:bonds.read"]}],"summary":"Get bond holding history","tags":["bonds"]}},"/bonds/get_bond_holdings":{"post":{"description":"Bondholders or bond portfolios at a date (default today) for companies, owners, parent owners' underlying holders or bond issues. Amounts are nominal in the bond currency and shares are fractions of the bond or of the company's debt, not equity. coverage and status report incomplete scopes. Requires the Monitor bonds product.","operationId":"get_bond_holdings","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"format":"date","type":["string","null"]},"bond_ids":{"description":"Restrict to these bond issues; at most 100","items":{"type":"string"},"type":"array"},"company_party_ids":{"description":"Company roots whose bondholders are requested; at most 50. Intersects owner selectors","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of holdings entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"minimum_maturity_date":{"description":"Optional explicit maturity cutoff; omitted includes matured issues","format":"date","type":["string","null"]},"owner_party_ids":{"description":"Owners whose bond portfolios are requested; at most 50","items":{"type":"string"},"type":"array"},"parent_party_ids":{"description":"Select underlying owners of these parents, not parent totals, including those held through their sub-managers (junior parents) at any depth; parent_party_id on each row is the direct parent, which may be a sub-manager. When expanded, a parent without children or sub-managers is returned as its own leaf. At most 50. Cannot combine with owner_party_ids or underlying","items":{"type":"string"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: bond_id (string; eq, in), currency (string; eq, in), isin (string; eq, in), nominal_amount (integer; eq, gt, gte, lt, lte), owner_country (string; eq, in), valid_from (date; eq, gt, gte, lt, lte). sort is a list of {field, desc} on: nominal_amount, share_of_bond_outstanding, share_of_company_debt, valid_from. search is a text match on: bond_name, owner_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["nominal_amount","share_of_bond_outstanding","share_of_company_debt","valid_from"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["bond_id","currency","isin","nominal_amount","owner_country","valid_from"],"type":"string"},"op":{"enum":["eq","gt","gte","in","lt","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"underlying":{"description":"Select underlying holders for company roots; cannot combine with owner or parent selectors","type":"boolean"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"holdings":{"items":{"additionalProperties":false,"properties":{"asset_class":{"enum":["bond"],"type":"string"},"at":{"type":["string","null"]},"bond_id":{"type":"string"},"bond_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"isin":{"type":["string","null"]},"issuer_id":{"type":"string"},"nominal_amount":{"description":"Full units in currency, not market value; null is unknown","type":["integer","null"]},"origin":{"items":{"type":"string"},"type":"array"},"owner_country":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Owner identity shared with equity","type":"string"},"parent_party_id":{"description":"Parent of the underlying owner; never add this child's holding to a parent total","type":["string","null"]},"root_company_party_id":{"description":"Nullable company root; preserve positions without a mapped company","type":["string","null"]},"share_of_bond_outstanding":{"description":"Fraction of this issue's outstanding nominal amount","type":["number","null"]},"share_of_company_debt":{"description":"Fraction of company outstanding debt, using FX at the reference date","type":["number","null"]},"share_of_company_debt_in_currency":{"description":"Fraction of company outstanding debt in this currency; no FX","type":["number","null"]},"valid_from":{"type":["string","null"]}},"required":["asset_class","owner_party_id","parent_party_id","owner_name","owner_country","bond_id","bond_name","isin","issuer_id","root_company_party_id","nominal_amount","currency","share_of_company_debt","share_of_company_debt_in_currency","share_of_bond_outstanding","at","valid_from","origin"],"type":"object"},"type":"array"},"level":{"enum":["default","underlying"],"type":"string"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"items":{"additionalProperties":false,"properties":{"party_id":{"description":"Requested identity this entry describes","type":"string"},"reason":{"type":"string"},"role":{"description":"Requested side. Company plus owner or parent requests list both sides; the paired side is complete only when every root it was paired with is","enum":["company","owner","parent"],"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["party_id","role","state"],"type":"object"},"type":"array"}},"required":["holdings","level","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get bond holdings"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:bonds.read"]}],"summary":"Get bond holdings","tags":["bonds"]}},"/bonds/list_bond_holding_changes":{"post":{"description":"Net bond holding changes between from and to, with the holdings before and after. Percentage changes can reflect FX or outstanding debt changes rather than trading. Requires the Monitor bonds product.","operationId":"list_bond_holding_changes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"bond_ids":{"description":"Restrict to these bond issues; at most 100","items":{"type":"string"},"type":"array"},"company_party_ids":{"description":"Company roots whose bondholders are requested; at most 50. Intersects owner selectors","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of deltas entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"minimum_maturity_date":{"description":"Optional explicit maturity cutoff; omitted includes matured issues","format":"date","type":["string","null"]},"owner_party_ids":{"description":"Owners whose bond portfolios are requested; at most 50","items":{"type":"string"},"type":"array"},"parent_party_ids":{"description":"Select underlying owners of these parents, not parent totals, including those held through their sub-managers (junior parents) at any depth; parent_party_id on each row is the direct parent, which may be a sub-manager. When expanded, a parent without children or sub-managers is returned as its own leaf. At most 50. Cannot combine with owner_party_ids or underlying","items":{"type":"string"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: bond_id (string; eq, in), currency (string; eq, in), delta_nominal_amount (integer; eq, gt, gte, lt, lte), from_holding.bond_id (string; eq, in), from_holding.currency (string; eq, in), from_holding.isin (string; eq, in), from_holding.nominal_amount (integer; eq, gt, gte, lt, lte), from_holding.owner_country (string; eq, in), from_holding.valid_from (string; eq, gt, gte, lt, lte), to_holding.bond_id (string; eq, in), to_holding.currency (string; eq, in), to_holding.isin (string; eq, in), to_holding.nominal_amount (integer; eq, gt, gte, lt, lte), to_holding.owner_country (string; eq, in), to_holding.valid_from (string; eq, gt, gte, lt, lte). sort is a list of {field, desc} on: delta_nominal_amount, from_holding.nominal_amount, from_holding.share_of_bond_outstanding, from_holding.share_of_company_debt, from_holding.valid_from, to_holding.nominal_amount, to_holding.share_of_bond_outstanding, to_holding.share_of_company_debt, to_holding.valid_from. search is a text match on: from_holding.bond_name, from_holding.owner_name, owner_name, to_holding.bond_name, to_holding.owner_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["delta_nominal_amount","from_holding.nominal_amount","from_holding.share_of_bond_outstanding","from_holding.share_of_company_debt","from_holding.valid_from","to_holding.nominal_amount","to_holding.share_of_bond_outstanding","to_holding.share_of_company_debt","to_holding.valid_from"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["bond_id","currency","delta_nominal_amount","from_holding.bond_id","from_holding.currency","from_holding.isin","from_holding.nominal_amount","from_holding.owner_country","from_holding.valid_from","to_holding.bond_id","to_holding.currency","to_holding.isin","to_holding.nominal_amount","to_holding.owner_country","to_holding.valid_from"],"type":"string"},"op":{"enum":["eq","gt","gte","in","lt","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"format":"date","type":["string","null"]},"underlying":{"description":"Select underlying holders for company roots; cannot combine with owner or parent selectors","type":"boolean"}},"required":["from","to"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"deltas":{"items":{"additionalProperties":false,"properties":{"asset_class":{"enum":["bond"],"type":"string"},"bond_id":{"type":"string"},"currency":{"type":["string","null"]},"delta_nominal_amount":{"description":"Signed recorded nominal change in full currency units; not proof of execution","type":["integer","null"]},"delta_share_of_bond_outstanding":{"type":["number","null"]},"delta_share_of_company_debt":{"type":["number","null"]},"delta_share_of_company_debt_in_currency":{"type":["number","null"]},"from_holding":{"additionalProperties":false,"properties":{"asset_class":{"enum":["bond"],"type":"string"},"at":{"type":["string","null"]},"bond_id":{"type":"string"},"bond_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"isin":{"type":["string","null"]},"issuer_id":{"type":"string"},"nominal_amount":{"description":"Full units in currency, not market value; null is unknown","type":["integer","null"]},"origin":{"items":{"type":"string"},"type":"array"},"owner_country":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Owner identity shared with equity","type":"string"},"parent_party_id":{"description":"Parent of the underlying owner; never add this child's holding to a parent total","type":["string","null"]},"root_company_party_id":{"description":"Nullable company root; preserve positions without a mapped company","type":["string","null"]},"share_of_bond_outstanding":{"description":"Fraction of this issue's outstanding nominal amount","type":["number","null"]},"share_of_company_debt":{"description":"Fraction of company outstanding debt, using FX at the reference date","type":["number","null"]},"share_of_company_debt_in_currency":{"description":"Fraction of company outstanding debt in this currency; no FX","type":["number","null"]},"valid_from":{"type":["string","null"]}},"required":["asset_class","owner_party_id","parent_party_id","owner_name","owner_country","bond_id","bond_name","isin","issuer_id","root_company_party_id","nominal_amount","currency","share_of_company_debt","share_of_company_debt_in_currency","share_of_bond_outstanding","at","valid_from","origin"],"type":["object","null"]},"issuer_id":{"type":"string"},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Owner identity shared with equity","type":"string"},"parent_party_id":{"description":"Parent of underlying owner when available","type":["string","null"]},"root_company_party_id":{"description":"Nullable root company","type":["string","null"]},"to_holding":{"additionalProperties":false,"properties":{"asset_class":{"enum":["bond"],"type":"string"},"at":{"type":["string","null"]},"bond_id":{"type":"string"},"bond_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"isin":{"type":["string","null"]},"issuer_id":{"type":"string"},"nominal_amount":{"description":"Full units in currency, not market value; null is unknown","type":["integer","null"]},"origin":{"items":{"type":"string"},"type":"array"},"owner_country":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Owner identity shared with equity","type":"string"},"parent_party_id":{"description":"Parent of the underlying owner; never add this child's holding to a parent total","type":["string","null"]},"root_company_party_id":{"description":"Nullable company root; preserve positions without a mapped company","type":["string","null"]},"share_of_bond_outstanding":{"description":"Fraction of this issue's outstanding nominal amount","type":["number","null"]},"share_of_company_debt":{"description":"Fraction of company outstanding debt, using FX at the reference date","type":["number","null"]},"share_of_company_debt_in_currency":{"description":"Fraction of company outstanding debt in this currency; no FX","type":["number","null"]},"valid_from":{"type":["string","null"]}},"required":["asset_class","owner_party_id","parent_party_id","owner_name","owner_country","bond_id","bond_name","isin","issuer_id","root_company_party_id","nominal_amount","currency","share_of_company_debt","share_of_company_debt_in_currency","share_of_bond_outstanding","at","valid_from","origin"],"type":["object","null"]}},"required":["asset_class","owner_party_id","parent_party_id","owner_name","bond_id","issuer_id","root_company_party_id","currency","delta_nominal_amount","delta_share_of_company_debt","delta_share_of_company_debt_in_currency","delta_share_of_bond_outstanding","from_holding","to_holding"],"type":"object"},"type":"array"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"from":{"type":"string"},"level":{"enum":["default","underlying"],"type":"string"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"items":{"additionalProperties":false,"properties":{"party_id":{"description":"Requested identity this entry describes","type":"string"},"reason":{"type":"string"},"role":{"description":"Requested side. Company plus owner or parent requests list both sides; the paired side is complete only when every root it was paired with is","enum":["company","owner","parent"],"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["party_id","role","state"],"type":"object"},"type":"array"},"to":{"type":"string"}},"required":["deltas","level","from","to","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List bond holding changes"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:bonds.read"]}],"summary":"List bond holding changes","tags":["bonds"]}},"/bonds/list_bonds":{"post":{"description":"Find bond issues by bond ID, ISIN, issuer or company. Selectors intersect. Returns issue details such as name, ISIN, currency, amounts and maturity. Requires the Monitor bonds product.","operationId":"list_bonds","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"description":"Reference date for outstanding debt; defaults to today UTC","format":"date","type":["string","null"]},"bond_ids":{"description":"Exact native bond IDs; at most 100","items":{"type":"string"},"type":"array"},"company_party_ids":{"description":"Company roots to discover bonds for; at most 50","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"isins":{"description":"Exact bond ISINs; at most 100","items":{"type":"string"},"type":"array"},"issuer_ids":{"description":"Exact native issuer IDs, distinct from company identities; at most 100","items":{"type":"string"},"type":"array"},"limit":{"default":50,"description":"Page size: maximum number of bonds entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"minimum_maturity_date":{"format":"date","type":["string","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: currency (string; eq, in), isin (string; eq, in), name (string; eq, in, contains). sort is a list of {field, desc} on: name. search is a text match on: name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["name"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["currency","isin","name"],"type":"string"},"op":{"enum":["contains","eq","in"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"bonds":{"items":{"additionalProperties":false,"properties":{"at":{"type":"string"},"bond_id":{"type":"string"},"currency":{"type":["string","null"]},"ibor":{"type":["string","null"]},"isin":{"type":["string","null"]},"issue_date":{"type":["string","null"]},"issuer_id":{"type":["string","null"]},"listed_debt":{"additionalProperties":false,"properties":{"amount":{"type":["number","null"]},"currency":{"type":["string","null"]}},"required":["amount","currency"],"type":["object","null"]},"listed_owners":{"type":["integer","null"]},"maturity_date":{"description":"Date or infinity for perpetual; null/-infinity means unavailable","type":["string","null"]},"name":{"type":["string","null"]},"outstanding":{"additionalProperties":false,"description":"Outstanding nominal amount at the reference date","properties":{"amount":{"type":["number","null"]},"currency":{"type":["string","null"]}},"required":["amount","currency"],"type":["object","null"]},"rate_class":{"type":["string","null"]},"root_company_party_id":{"description":"Nullable company root; unindexed and unmapped bonds remain in results","type":["string","null"]}},"required":["bond_id","issuer_id","root_company_party_id","name","isin","currency","issue_date","maturity_date","rate_class","ibor","outstanding","listed_debt","listed_owners","at"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["bonds","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List bonds"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:bonds.read"]}],"summary":"List bonds","tags":["bonds"]}},"/crm/list_coworkers":{"post":{"description":"List the customer's coworkers (coworker_id, name, role) for coworker filters in list_events.","operationId":"list_coworkers","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coworkers":{"description":"List of customer coworkers","items":{"additionalProperties":false,"properties":{"coworker_id":{"format":"uuid","type":"string"},"hidden":{"description":"Indicates if the coworker is hidden by the customer","type":"boolean"},"name":{"type":"string"},"role":{"type":["string","null"]}},"required":["coworker_id","name"],"type":"object"},"type":"array"}},"required":["coworkers"],"type":"object"}}},"description":"List coworkers"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"List coworkers","tags":["crm"]}},"/crm/list_event_filter_values":{"post":{"description":"The values accepted by list_events filters: meeting contexts, labels (by label_id) and the organizers and locations used on the 5000 most recent events. Use the values verbatim.","operationId":"list_event_filter_values","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"categories":{"description":"Complete supported event categories for query.where category","items":{"type":"string"},"type":"array"},"contexts":{"description":"Supported meeting contexts; list_events also accepts case and spacing variants.","items":{"type":"string"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"group_types":{"description":"Complete supported event group types for query.where group.group_type","items":{"type":"string"},"type":"array"},"labels":{"description":"List of labels available for filtering events","items":{"additionalProperties":false,"properties":{"label_id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["label_id","name"],"type":"object"},"type":"array"},"locations":{"description":"List of unique locations available for filtering events","items":{"type":"string"},"type":"array"},"organizers":{"description":"List of unique organizers available for filtering events","items":{"type":"string"},"type":"array"}},"required":["contexts","categories","group_types","labels","organizers","locations","coverage","dropped_ids"],"type":"object"}}},"description":"List event filter values"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"List event filter values","tags":["crm"]}},"/crm/list_event_groups":{"post":{"description":"CRM event groups such as roadshows, optionally by event_group_ids, with comments, event IDs and first and last event times.","operationId":"list_event_groups","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"event_group_ids":{"description":"Optional event group IDs; omit for all groups.","items":{"type":"string"},"type":["array","null"]},"limit":{"default":50,"description":"Page size: maximum number of event_groups entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where accepts the field group_type with op eq or in.","properties":{"where":{"items":{"additionalProperties":false,"properties":{"field":{"type":"string"},"op":{"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"event_groups":{"items":{"additionalProperties":false,"properties":{"comments":{"items":{"additionalProperties":false,"properties":{"author":{"type":["string","null"]},"comment_id":{"format":"uuid","type":"string"},"subject_type":{"type":"string"},"value":{"description":"Comment text as plain text (HTML removed)","type":"string"}},"required":["comment_id","subject_type","value","author"],"type":"object"},"type":"array"},"event_group_id":{"format":"uuid","type":"string"},"event_ids":{"items":{"type":"string"},"type":"array"},"first_event_start_time":{"type":"string"},"group_type":{"description":"Roadshow or Conference","type":"string"},"last_event_end_time":{"type":"string"},"title":{"type":"string"}},"required":["group_type","event_group_id","title","event_ids","comments","first_event_start_time","last_event_end_time"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["event_groups","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List event groups"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"List event groups","tags":["crm"]}},"/crm/list_events":{"post":{"description":"CRM events (meetings, calls and other investor interactions), newest first, by event ID or filtered by participants, coworkers, labels, targeting lists, context, location, organizer or date, or searched with query.search. Returns metadata, participants, coworkers, labels, notes as plain text, attachments and event group; include_equity adds participants' holding changes.","operationId":"list_events","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"contact_ids":{"description":"Events attended by these CRM contacts","items":{"type":"string"},"type":["array","null"]},"coworker_ids":{"description":"Any attending coworker ID from list_coworkers.","items":{"format":"uuid","type":"string"},"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"equity_change_scope":{"description":"any_participant (default): anyone changed holdings. matching_participants: changing entity or attending contact matches participant/list selectors; requires a selector and equity filtering. Independent of participant_scope.","enum":["any_participant","matching_participants"],"type":"string"},"event_ids":{"description":"Match these event IDs.","items":{"format":"uuid","type":"string"},"type":["array","null"]},"include_equity":{"description":"Include participant holding changes; default false.","type":["boolean","null"]},"label_ids":{"description":"Any label ID from list_event_filter_values.","items":{"format":"uuid","type":"string"},"type":["array","null"]},"limit":{"default":50,"description":"Page size: maximum number of events entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"only_events_led_to_equity_change":{"description":"Require nonzero delta_shares under equity_change_scope; null is not a match. false/omitted: unrestricted.","type":["boolean","null"]},"participant_scope":{"description":"all (default): every attendee. matching: intersect participant/list selectors; requires one. List membership is direct, not inherited. Event totals unchanged.","enum":["all","matching"],"type":"string"},"party_ids":{"description":"Events attended by these CRM parties","items":{"type":"string"},"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: category (string; eq, in), context (string; eq, in), group.group_type (string; eq, in), location (string; eq, in), organizer (string; eq, in), start_date (date; gte, lte). search: Full-text search over the events. category: Equity, Debt, Equity and debt. context: Event meeting format. Accepted values: CMD, Call, Follow-up, Group meeting, One-on-one, Other, Pre-silent call, Presentation, Quarterly update, Site visit. Unique case/whitespace and space-separated equivalents are normalized; unknown values return suggestions. group.group_type: Roadshow, Conference. location: Exact case-sensitive text; reuse list_event_filter_values locations. Each requested value is checked against an incomplete recent-event sample; absent values produce advisory suggestions. organizer: Exact case-sensitive text; reuse list_event_filter_values organizers. Each requested value is checked against an incomplete recent-event sample; absent values produce advisory suggestions.","properties":{"search":{"description":"Full-text search over the events.","type":"string"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["category","context","group.group_type","location","organizer","start_date"],"type":"string"},"op":{"enum":["eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"targeting_list_ids":{"description":"Events with any person/entity in these lists (list_targeting_lists).","items":{"format":"uuid","type":"string"},"type":["array","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"events":{"description":"Matching events; participants follow participant_scope","items":{"additionalProperties":false,"properties":{"attachments":{"items":{"additionalProperties":false,"properties":{"file_id":{"type":"string"},"file_name":{"type":["string","null"]},"file_type":{"description":"MIME type of the file","type":["string","null"]}},"required":["file_id"],"type":"object"},"type":"array"},"category":{"description":"Security class discussed: Equity, Debt or Equity and debt","type":["string","null"]},"context":{"type":"string"},"coworkers":{"description":"List of coworkers participating on the event","items":{"additionalProperties":false,"properties":{"coworker_id":{"format":"uuid","type":"string"},"display_name":{"type":"string"},"role":{"type":["string","null"]}},"required":["coworker_id","display_name"],"type":"object"},"type":"array"},"created_at":{"type":"string"},"end_time":{"type":"string"},"event_id":{"format":"uuid","type":"string"},"group":{"additionalProperties":false,"description":"The group (roadshow) this event belongs to, if any","properties":{"event_group_id":{"format":"uuid","type":"string"},"group_type":{"description":"Roadshow or Conference","type":"string"},"title":{"type":"string"}},"required":["event_group_id","title","group_type"],"type":["object","null"]},"labels":{"description":"Tagged labels","items":{"additionalProperties":false,"properties":{"colour":{"type":"string"},"label_id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["label_id","name","colour"],"type":"object"},"type":"array"},"location":{"type":["string","null"]},"notes":{"description":"All notes on the event as plain text (HTML removed; comments and paragraphs separated by blank lines); null when there are no notes","type":["string","null"]},"organizer":{"type":["string","null"]},"participants":{"description":"List of external participants on the event","items":{"additionalProperties":false,"properties":{"entity":{"additionalProperties":false,"description":"Entity information","properties":{"country":{"description":"Domicile of the entity","type":["string","null"]},"is_sell_side":{"description":"Whether the entity is sell-side or buy-side","type":"boolean"},"name":{"type":"string"},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]}},"required":["party_id","name","is_sell_side"],"type":"object"},"entity_is_context_only":{"description":"With matching scope, true means the entity is shown only to identify a matched contact and is excluded from party statistics","type":"boolean"},"equity_delta":{"additionalProperties":false,"description":"Holding change around the event; omitted when unrequested or unavailable.","properties":{"capital":{"description":"Fraction of the company's capital held by the entity after the event (0.0 to 1.0, where 1.0 = 100%)","type":"number"},"delta_capital":{"description":"Change in capital fraction held by the entity from before to after the event (same 0.0-1.0 scale as capital; can be negative)","type":"number"},"delta_shares":{"description":"Change in number of shares held by the entity from before to after the event (can be negative)","type":"integer"},"verified":{"description":"Date when the equity delta was verified, in ISO 8601 format","type":"string"}},"required":["verified","capital","delta_capital","delta_shares"],"type":["object","null"]},"persons":{"description":"List of persons from this entity","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID of this CRM person","type":["string","null"]},"display_name":{"description":"Display name of the person","type":"string"}},"required":["contact_id","display_name"],"type":"object"},"type":"array"}},"required":["entity","persons"],"type":"object"},"type":"array"},"start_time":{"type":"string"},"timezone":{"type":["string","null"]},"title":{"type":["string","null"]},"updated_at":{"type":"string"}},"required":["attachments","event_id","title","start_time","end_time","timezone","location","organizer","context","created_at","updated_at","participants","coworkers","labels"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["coverage","dropped_ids","events","next_cursor"],"type":"object"}}},"description":"List events"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"List events","tags":["crm"]}},"/crm/list_targeting_lists":{"post":{"description":"The customer's targeting lists, optionally by ID, each with name, timestamps and member contacts and entities.","operationId":"list_targeting_lists","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of targeting_lists entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"targeting_list_ids":{"description":"Optional list IDs; omit for all accessible lists","items":{"type":"string"},"type":["array","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"targeting_lists":{"items":{"additionalProperties":false,"properties":{"created_at":{"type":"string"},"entities":{"description":"Entities in the targeting list","items":{"additionalProperties":false,"properties":{"name":{"description":"Name of the entity","type":"string"},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]}},"required":["party_id","name"],"type":"object"},"type":"array"},"name":{"type":"string"},"persons":{"description":"Persons in the targeting list","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID of this CRM person","type":["string","null"]},"name":{"description":"Name of the person","type":"string"}},"required":["contact_id","name"],"type":"object"},"type":"array"},"targeting_list_id":{"format":"uuid","type":"string"},"updated_at":{"type":"string"}},"required":["targeting_list_id","name","entities","persons","created_at","updated_at"],"type":"object"},"type":"array"}},"required":["targeting_lists","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List targeting lists"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"List targeting lists","tags":["crm"]}},"/crm/search_contacts":{"post":{"description":"Fetch CRM contacts (persons) by contact_id or search them with query.search, a word-level match on name, employer, role and email. Returns jobs with contact details, managed funds or mandates and the latest event.","operationId":"search_contacts","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"contact_ids":{"description":"Optional CRM contact IDs to fetch; at most 500. Omit, null or an empty array means no ID filter.","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of persons entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: has_event (boolean; eq), job_city (string; eq, in), job_country (string; eq, in), name (string; eq, ne, contains, in). sort is a list of {field, desc} on: name. search is a text match on: name. job_city: Exact job city text; spelling is not corrected without an authoritative catalog. job_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["name"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["has_event","job_city","job_country","name"],"type":"string"},"op":{"enum":["contains","eq","in","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"persons":{"description":"List of persons matching the search term","items":{"additionalProperties":false,"properties":{"assignments":{"description":"Funds or mandates the person manages or covers. Not employments: no role or contact details, the employer is in jobs","items":{"additionalProperties":false,"properties":{"entity":{"additionalProperties":false,"description":"The fund or mandate the person is assigned to","properties":{"country":{"description":"Country of the entity","type":"string"},"name":{"description":"Name of the entity","type":"string"},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]}},"required":["party_id","name","country"],"type":"object"}},"required":["entity"],"type":"object"},"type":"array"},"contact_id":{"description":"Canonical contact ID of this CRM person","type":["string","null"]},"jobs":{"description":"Employments: where the person works, with role and contact details","items":{"additionalProperties":false,"properties":{"entity":{"additionalProperties":false,"description":"The employer","properties":{"country":{"description":"Country of the entity","type":"string"},"name":{"description":"Name of the entity","type":"string"},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]}},"required":["party_id","name","country"],"type":"object"},"person_email":{"description":"Email of the person in the job","type":["string","null"]},"person_role":{"description":"Role of the person in the job","type":["string","null"]},"person_tel":{"description":"Telephone number of the person in the job","type":["string","null"]}},"required":["entity"],"type":"object"},"type":"array"},"last_event":{"description":"Latest event by start time; may be upcoming","items":{"additionalProperties":false,"properties":{"end_time":{"format":"date-time","type":"string"},"event_id":{"format":"uuid","type":"string"},"start_time":{"format":"date-time","type":"string"},"timezone":{"type":["string","null"]}},"required":["event_id","start_time","end_time"],"type":"object"},"type":"array"},"name":{"description":"Name of the person","type":"string"}},"required":["contact_id","name","jobs","assignments","last_event"],"type":"object"},"type":"array"}},"required":["persons","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Search contacts"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"Search contacts","tags":["crm"]}},"/crm/search_crm_entities":{"post":{"description":"Fetch CRM entities (organisations) by party_id or search them with query.search, a word-level match on the entity and parent names. Returns entity details, jobs, assignments, parent and the latest event.","operationId":"search_crm_entities","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of entities entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Optional CRM party IDs (entity or owner forms) to fetch; at most 500. Omit, null or an empty array means no ID filter.","items":{"type":"string"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: country (string; eq, in), has_event (boolean; eq), manager_city (string; eq, in), name (string; eq, ne, contains, in). sort is a list of {field, desc} on: country, name. search is a text match on: name. country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions. manager_city: Exact manager city text; spelling is not corrected without an authoritative catalog.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["country","name"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["country","has_event","manager_city","name"],"type":"string"},"op":{"enum":["contains","eq","in","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"entities":{"description":"List of entities matching the search term","items":{"additionalProperties":false,"properties":{"assignments":{"description":"Persons managing or covering this fund or mandate","items":{"additionalProperties":false,"properties":{"person":{"additionalProperties":false,"description":"The assigned person","properties":{"contact_id":{"description":"Canonical contact ID of this CRM person","type":["string","null"]},"name":{"type":"string"}},"required":["contact_id","name"],"type":"object"}},"required":["person"],"type":"object"},"type":"array"},"country":{"description":"Domicile of the entity, ISO 3166-1 alpha-2","type":"string"},"investment_strategy":{"type":["string","null"]},"jobs":{"description":"Employees with role and contact details","items":{"additionalProperties":false,"properties":{"person":{"additionalProperties":false,"description":"Person associated with the job","properties":{"contact_id":{"description":"Canonical contact ID of this CRM person","type":["string","null"]},"name":{"type":"string"}},"required":["contact_id","name"],"type":"object"},"person_email":{"description":"Email of the person in the job","type":["string","null"]},"person_role":{"description":"Role of the person at the job","type":["string","null"]},"person_tel":{"description":"Work phone","type":["string","null"]}},"required":["person"],"type":"object"},"type":"array"},"last_event":{"description":"Latest event by start time; may be upcoming","items":{"additionalProperties":false,"properties":{"end_time":{"format":"date-time","type":"string"},"event_id":{"format":"uuid","type":"string"},"start_time":{"format":"date-time","type":"string"},"timezone":{"type":["string","null"]}},"required":["event_id","start_time","end_time"],"type":"object"},"type":"array"},"name":{"type":"string"},"parent":{"additionalProperties":false,"properties":{"country":{"description":"Domicile of the entity","type":"string"},"investment_strategy":{"type":["string","null"]},"name":{"type":"string"},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]},"profile":{"type":["string","null"]}},"required":["party_id","name","country"],"type":["object","null"]},"party_id":{"description":"Canonical party ID; null when the entity is not indexed","type":["string","null"]},"profile":{"type":["string","null"]}},"required":["party_id","name","country","jobs","assignments","last_event"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["entities","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Search CRM entities"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:crm.read"]}],"summary":"Search CRM entities","tags":["crm"]}},"/documents/get_press_releases":{"post":{"description":"Full press releases by press_release_id: title, publishing company, language, publish date and Markdown content. Unknown IDs are listed in missing_press_release_ids.","operationId":"get_press_releases","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":10,"description":"Page size: maximum number of press_release_ids fetched per call, 1-500, default 10. The remaining IDs are fetched with next_cursor.","maximum":500,"minimum":1,"type":["integer","null"]},"press_release_ids":{"description":"Required: 1–1000 press_release_ids returned by list_press_releases or search_press_releases. Duplicate IDs are fetched once.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["press_release_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"missing_press_release_ids":{"description":"Requested release IDs that were not found","items":{"type":"string"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"press_releases":{"items":{"additionalProperties":false,"properties":{"author_name":{"type":"string"},"content":{"description":"Full markdown content of the press release","type":"string"},"lang":{"type":["string","null"]},"party_id":{"description":"Party ID with an issuer record","type":["string","null"]},"press_release_id":{"description":"Press release id","type":"string"},"publish_date":{"description":"Publish date of the press release","type":"string"},"title":{"type":"string"}},"required":["press_release_id","author_name","title","lang","party_id","publish_date","content"],"type":"object"},"type":"array"}},"required":["missing_press_release_ids","coverage","dropped_ids","press_releases","next_cursor"],"type":"object"}}},"description":"Get press releases"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:documents.read"]}],"summary":"Get press releases","tags":["documents"]}},"/documents/get_transcripts":{"post":{"description":"Full transcripts by transcript_id from list_transcripts: event metadata, speakers and the spoken text as ordered paragraphs with speaker attribution. Unknown IDs are listed in missing_transcript_ids.","operationId":"get_transcripts","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":5,"description":"Page size: maximum number of transcript_ids fetched per call, 1-100, default 5. The remaining IDs are fetched with next_cursor.","maximum":100,"minimum":1,"type":["integer","null"]},"transcript_ids":{"description":"Required: 1–100 positive transcript_ids returned by list_transcripts. Duplicate IDs are fetched once.","items":{"type":"integer"},"maxItems":100,"minItems":1,"type":"array"}},"required":["transcript_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"missing_transcript_ids":{"description":"Requested IDs that were not found","items":{"type":"integer"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"transcripts":{"items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Canonical issuer party ID; null when unavailable. Use this to associate the transcript with its company.","type":["string","null"]},"event":{"additionalProperties":false,"properties":{"date":{"type":"string"},"fiscal_period":{"type":"string"},"fiscal_year":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"}},"required":["title","date","language","fiscal_year","fiscal_period"],"type":"object"},"paragraphs":{"description":"Ordered paragraphs of the transcript, each with the speaker and the spoken text; empty when no text is available.","items":{"additionalProperties":false,"properties":{"speaker":{"additionalProperties":false,"properties":{"company":{"description":"Affiliation of the speaker","type":"string"},"name":{"description":"Name of the speaker in the transcript","type":"string"},"role":{"description":"Role of the speaker in the transcript, e.g. 'speaker', 'interviewer'","type":"string"}},"required":["name","company","role"],"type":["object","null"]},"text":{"type":"string"}},"required":["text","speaker"],"type":"object"},"type":"array"},"speakers":{"description":"List of speakers in the transcript","items":{"additionalProperties":false,"properties":{"company":{"description":"Affiliation of the speaker","type":"string"},"name":{"description":"Name of the speaker in the transcript","type":"string"},"role":{"description":"Role of the speaker in the transcript, e.g. 'speaker', 'interviewer'","type":"string"}},"required":["name","company","role"],"type":"object"},"type":"array"},"transcript_id":{"type":"integer"}},"required":["company_party_id","transcript_id","event","speakers","paragraphs"],"type":"object"},"type":"array"}},"required":["coverage","dropped_ids","transcripts","missing_transcript_ids","next_cursor"],"type":"object"}}},"description":"Get transcripts"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:documents.read"]}],"summary":"Get transcripts","tags":["documents"]}},"/documents/list_press_releases":{"post":{"description":"List press release metadata (title, language, publish date, company) without body text, newest first. Filter by publishing company with party_ids and by title, language or publish_date with query.where; dates are UTC timestamps like 2025-01-01T00:00:00Z. Read releases with get_press_releases.","operationId":"list_press_releases","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of press_releases entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Party IDs with an issuer record","items":{"type":"string"},"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: lang (string; eq, in, gte, lte), publish_date (string; eq, in, gte, lte), title (string; eq, in, gte, lte). sort is a list of {field, desc} on: lang, publish_date, title.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["lang","publish_date","title"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["lang","publish_date","title"],"type":"string"},"op":{"enum":["eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"press_releases":{"items":{"additionalProperties":false,"properties":{"author_name":{"type":"string"},"lang":{"type":["string","null"]},"party_id":{"description":"Party ID with an issuer record","type":["string","null"]},"press_release_id":{"type":"string"},"publish_date":{"description":"Publish date of the press release","type":"string"},"title":{"description":"Title of the press release","type":"string"}},"required":["press_release_id","author_name","title","lang","party_id","publish_date"],"type":"object"},"type":"array"}},"required":["coverage","dropped_ids","press_releases","next_cursor"],"type":"object"}}},"description":"List press releases"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:documents.read"]}],"summary":"List press releases","tags":["documents"]}},"/documents/list_transcripts":{"post":{"description":"List transcripts (earnings calls, trading updates, investor presentations) of the given companies, newest first, with transcript_id, title, date, language and fiscal period but no text. Read them with get_transcripts.","operationId":"list_transcripts","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of transcripts entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Issuer party IDs whose transcripts to list. Required. Any issuer can be requested; an empty result means no matching calls were ingested, not that no calls were held","items":{"type":"string"},"minItems":1,"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: event.date (eq, in, gte, lte, contains), event.fiscal_period (eq, in, gte, lte, contains), event.fiscal_year (eq, in, gte, lte, contains), event.language (eq, in, gte, lte, contains), event.title (eq, in, gte, lte, contains). sort is a list of {field, desc} on: event.date, event.fiscal_period, event.fiscal_year, event.language, event.title.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["event.date","event.fiscal_period","event.fiscal_year","event.language","event.title"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["event.date","event.fiscal_period","event.fiscal_year","event.language","event.title"],"type":"string"},"op":{"enum":["contains","eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"transcripts":{"description":"List of transcripts, matching the filter","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Canonical issuer party ID; null when unavailable. Use this to associate the transcript with its company.","type":["string","null"]},"event":{"additionalProperties":false,"properties":{"date":{"type":"string"},"fiscal_period":{"type":"string"},"fiscal_year":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"}},"required":["title","date","language","fiscal_year","fiscal_period"],"type":"object"},"transcript_id":{"type":"integer"}},"required":["company_party_id","transcript_id","event"],"type":"object"},"type":"array"}},"required":["coverage","dropped_ids","transcripts","next_cursor"],"type":"object"}}},"description":"List transcripts"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:documents.read"]}],"summary":"List transcripts","tags":["documents"]}},"/documents/search_press_releases":{"post":{"description":"Semantic search over press release text. Returns the best matching passages (chunks) with press_release_id; several may come from the same release. The nearest passages are always returned, so check their relevance. Read whole releases with get_press_releases.","operationId":"search_press_releases","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Inclusive lower bound on publish date. Must be RFC3339 in UTC with a trailing Z (e.g. 2025-01-01T00:00:00Z); the comparison is textual, so offsets like +02:00 give wrong results","format":"date-time","type":["string","null"]},"limit":{"default":10,"description":"Page size: maximum number of chunks entries, 1-100, default 10.","maximum":100,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Party IDs with an issuer record","items":{"type":"string"},"type":["array","null"]},"search":{"description":"Natural-language query. The nearest passages are returned even when off-topic, so check each one. Works best with a short topical phrase; use party_ids, from and to for companies and dates.","type":"string"},"to":{"description":"Inclusive upper bound on publish date, same format as from. Use end-of-day (T23:59:59Z) to include the whole day","format":"date-time","type":["string","null"]}},"required":["search"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"chunks":{"items":{"additionalProperties":false,"properties":{"chunk_id":{"description":"Chunk identifier","type":"integer"},"content":{"description":"Fetched chunk content","type":"string"},"press_release_id":{"description":"Press release id","type":"string"}},"required":["press_release_id","chunk_id","content"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["chunks","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Search press releases"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:documents.read"]}],"summary":"Search press releases","tags":["documents"]}},"/estimates/get_actuals":{"post":{"description":"Reported actual values per KPI and fiscal period with the consensus that preceded each report, for comparing outcomes with expectations. Omit periods for all reported history or pass up to 20. Percentages are fractions (0.042 = 4.2%). Requires the Monitor estimates product.","operationId":"get_actuals","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"customer_kpi_ids":{"description":"Omit, null or empty for all active customer KPIs (enabled for actuals or estimates)","items":{"type":"string"},"type":"array"},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of actuals entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"periods":{"description":"Up to 20 selected periods; omit, null or empty for all available reported history","items":{"additionalProperties":false,"properties":{"fiscal_quarter":{"description":"1–4; omit for FY. Half-year labels follow the customer reporting calendar.","type":["integer","null"]},"fiscal_year":{"type":"integer"}},"required":["fiscal_year"],"type":"object"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: consensus_date (date; eq, ne, in, gt, gte, lt, lte), consensus_status (string; eq, ne, in, contains), currency (string; eq, ne, in, contains), fiscal_quarter (integer; eq, ne, in, gt, gte, lt, lte), fiscal_year (integer; eq, ne, in, gt, gte, lt, lte), group_name (string; eq, ne, in, contains), kpi_name (string; eq, ne, in, contains), period (string; eq, ne, in, contains), report_date (date; eq, ne, in, gt, gte, lt, lte), unit (string; eq, ne, in, contains), value (number; eq, ne, in, gt, gte, lt, lte). sort is a list of {field, desc} on: consensus_date, consensus_status, currency, fiscal_quarter, fiscal_year, group_name, kpi_name, period, report_date, unit, value.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["consensus_date","consensus_status","currency","fiscal_quarter","fiscal_year","group_name","kpi_name","period","report_date","unit","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["consensus_date","consensus_status","currency","fiscal_quarter","fiscal_year","group_name","kpi_name","period","report_date","unit","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"actuals":{"items":{"additionalProperties":false,"properties":{"consensus":{"description":"Same units as value; for percent KPIs, a fraction (0.01 = one percentage point for differences)","type":["number","null"]},"consensus_date":{"type":["string","null"]},"consensus_high":{"description":"Same units as value; for percent KPIs, a fraction (0.01 = one percentage point for differences)","type":["number","null"]},"consensus_low":{"description":"Same units as value; for percent KPIs, a fraction (0.01 = one percentage point for differences)","type":["number","null"]},"consensus_status":{"description":"available, missing_report_date, unavailable or missing_estimates","type":"string"},"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"display_scale":{"description":"Display divisor; for percent, multiply value/display_scale by 100 and append %","type":"integer"},"fiscal_quarter":{"description":"Backend fiscal quarter, null for full year; period retains half-year reporter labels","type":["integer","null"]},"fiscal_year":{"type":"integer"},"group_name":{"type":["string","null"]},"kpi_name":{"type":"string"},"number_of_firms":{"type":["integer","null"]},"period":{"type":"string"},"report_date":{"type":["string","null"]},"unit":{"description":"KPI unit; percent means a fraction (1 = 100%)","type":"string"},"value":{"description":"Numeric value: percentage KPIs use fractions (0.042 = 4.2%); other KPIs use base units; null if missing","type":["number","null"]}},"required":["customer_kpi_id","kpi_name","fiscal_year","fiscal_quarter","period","value","unit","currency","display_scale","report_date","consensus_date","consensus_status","consensus","consensus_high","consensus_low","number_of_firms"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["actuals","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get actuals"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get actuals","tags":["estimates"]}},"/estimates/get_consensus":{"post":{"description":"Consensus estimates per KPI and fiscal period at a snapshot date (default today), with value, unit, currency and number of contributing firms. Omit customer_kpi_ids for all active KPIs. Requires the Monitor estimates product.","operationId":"get_consensus","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"description":"Snapshot date; defaults to today, not the fiscal period","format":"date","type":["string","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"customer_kpi_ids":{"description":"Omit, null or empty for all active customer KPIs (enabled for actuals or estimates)","items":{"type":"string"},"type":"array"},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of consensus entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: currency (string; eq, ne, in, contains), fiscal_quarter (integer; eq, ne, in, gt, gte, lt, lte), fiscal_year (integer; eq, ne, in, gt, gte, lt, lte), group_name (string; eq, ne, in, contains), kpi_name (string; eq, ne, in, contains), number_of_firms (integer; eq, ne, in, gt, gte, lt, lte), period (string; eq, ne, in, contains), snapshot_date (date; eq, ne, in, gt, gte, lt, lte), unit (string; eq, ne, in, contains), value (number; eq, ne, in, gt, gte, lt, lte). sort is a list of {field, desc} on: currency, fiscal_quarter, fiscal_year, group_name, kpi_name, number_of_firms, period, snapshot_date, unit, value.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["currency","fiscal_quarter","fiscal_year","group_name","kpi_name","number_of_firms","period","snapshot_date","unit","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["currency","fiscal_quarter","fiscal_year","group_name","kpi_name","number_of_firms","period","snapshot_date","unit","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"consensus":{"description":"Same units as value; for percent KPIs, a fraction (0.01 = one percentage point for differences)","items":{"additionalProperties":false,"properties":{"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"display_scale":{"description":"Display divisor; for percent, multiply value/display_scale by 100 and append %","type":"integer"},"fiscal_quarter":{"description":"Backend fiscal quarter, null for full year; period retains half-year reporter labels","type":["integer","null"]},"fiscal_year":{"type":"integer"},"group_name":{"type":["string","null"]},"kpi_name":{"type":"string"},"last_updated":{"type":["string","null"]},"number_of_firms":{"type":"integer"},"period":{"type":"string"},"snapshot_date":{"type":"string"},"unit":{"description":"KPI unit; percent means a fraction (1 = 100%)","type":"string"},"value":{"description":"Numeric value: percentage KPIs use fractions (0.042 = 4.2%); other KPIs use base units; null if missing","type":["number","null"]}},"required":["customer_kpi_id","kpi_name","fiscal_year","fiscal_quarter","period","value","unit","currency","display_scale","snapshot_date","number_of_firms","last_updated"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["consensus","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get consensus"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get consensus","tags":["estimates"]}},"/estimates/get_consensus_history":{"post":{"description":"How the consensus for given fiscal periods developed over time, one row per KPI and period for each day the consensus changed; value is null once the period has no consensus left, e.g. after its report. At most 500 KPI and period combinations; omit customer_kpi_ids for all active KPIs. Requires the Monitor estimates product.","operationId":"get_consensus_history","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"customer_kpi_ids":{"description":"Omit, null or empty for all active customer KPIs (enabled for actuals or estimates)","items":{"type":"string"},"type":"array"},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of consensus entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"periods":{"description":"Requested fiscal periods; at most 500 KPI/period combinations","items":{"additionalProperties":false,"properties":{"fiscal_quarter":{"description":"1–4; omit for FY. Half-year labels follow the customer reporting calendar.","type":["integer","null"]},"fiscal_year":{"type":"integer"}},"required":["fiscal_year"],"type":"object"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: currency (string; eq, ne, in, contains), fiscal_quarter (integer; eq, ne, in, gt, gte, lt, lte), fiscal_year (integer; eq, ne, in, gt, gte, lt, lte), group_name (string; eq, ne, in, contains), kpi_name (string; eq, ne, in, contains), number_of_firms (integer; eq, ne, in, gt, gte, lt, lte), period (string; eq, ne, in, contains), snapshot_date (date; eq, ne, in, gt, gte, lt, lte), unit (string; eq, ne, in, contains), value (number; eq, ne, in, gt, gte, lt, lte). sort is a list of {field, desc} on: currency, fiscal_quarter, fiscal_year, group_name, kpi_name, number_of_firms, period, snapshot_date, unit, value.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["currency","fiscal_quarter","fiscal_year","group_name","kpi_name","number_of_firms","period","snapshot_date","unit","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["currency","fiscal_quarter","fiscal_year","group_name","kpi_name","number_of_firms","period","snapshot_date","unit","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["periods"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"consensus":{"description":"Same units as value; for percent KPIs, a fraction (0.01 = one percentage point for differences)","items":{"additionalProperties":false,"properties":{"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"display_scale":{"description":"Display divisor; for percent, multiply value/display_scale by 100 and append %","type":"integer"},"fiscal_quarter":{"description":"Backend fiscal quarter, null for full year; period retains half-year reporter labels","type":["integer","null"]},"fiscal_year":{"type":"integer"},"group_name":{"type":["string","null"]},"kpi_name":{"type":"string"},"last_updated":{"type":["string","null"]},"number_of_firms":{"type":"integer"},"period":{"type":"string"},"snapshot_date":{"type":"string"},"unit":{"description":"KPI unit; percent means a fraction (1 = 100%)","type":"string"},"value":{"description":"Numeric value: percentage KPIs use fractions (0.042 = 4.2%); other KPIs use base units; null if missing","type":["number","null"]}},"required":["customer_kpi_id","kpi_name","fiscal_year","fiscal_quarter","period","value","unit","currency","display_scale","snapshot_date","number_of_firms","last_updated"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["consensus","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get consensus history"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get consensus history","tags":["estimates"]}},"/estimates/get_firm_estimates":{"post":{"description":"Each research firm's current estimates per KPI and fiscal period at a snapshot date (default today), with the date of the underlying analysis. Omit customer_kpi_ids for all active KPIs. Requires the Monitor estimates product.","operationId":"get_firm_estimates","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"description":"Snapshot date; defaults to today, not the fiscal period","format":"date","type":["string","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"customer_kpi_ids":{"description":"Omit, null or empty for all active customer KPIs (enabled for actuals or estimates)","items":{"type":"string"},"type":"array"},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of estimates entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: analysis_date (date; eq, ne, in, gt, gte, lt, lte), currency (string; eq, ne, in, contains), firm_name (string; eq, ne, in, contains), firm_party_id (string; eq, ne, in), fiscal_quarter (integer; eq, ne, in, gt, gte, lt, lte), fiscal_year (integer; eq, ne, in, gt, gte, lt, lte), group_name (string; eq, ne, in, contains), kpi_name (string; eq, ne, in, contains), period (string; eq, ne, in, contains), unit (string; eq, ne, in, contains), value (number; eq, ne, in, gt, gte, lt, lte). sort is a list of {field, desc} on: analysis_date, currency, firm_name, firm_party_id, fiscal_quarter, fiscal_year, group_name, kpi_name, period, unit, value.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["analysis_date","currency","firm_name","firm_party_id","fiscal_quarter","fiscal_year","group_name","kpi_name","period","unit","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["analysis_date","currency","firm_name","firm_party_id","fiscal_quarter","fiscal_year","group_name","kpi_name","period","unit","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"estimates":{"items":{"additionalProperties":false,"properties":{"analysis_date":{"type":"string"},"analysis_id":{"type":"integer"},"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"display_scale":{"description":"Display divisor; for percent, multiply value/display_scale by 100 and append %","type":"integer"},"firm_name":{"type":"string"},"firm_party_id":{"description":"Analysis firm party ID","type":["string","null"]},"fiscal_quarter":{"description":"Backend fiscal quarter, null for full year; period retains half-year reporter labels","type":["integer","null"]},"fiscal_year":{"type":"integer"},"group_name":{"type":["string","null"]},"kpi_name":{"type":"string"},"period":{"type":"string"},"snapshot_date":{"type":["string","null"]},"unit":{"description":"KPI unit; percent means a fraction (1 = 100%)","type":"string"},"value":{"description":"Numeric value: percentage KPIs use fractions (0.042 = 4.2%); other KPIs use base units; null if missing","type":["number","null"]}},"required":["customer_kpi_id","kpi_name","fiscal_year","fiscal_quarter","period","value","unit","currency","display_scale","firm_party_id","firm_name","analysis_id","analysis_date"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["estimates","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get firm estimates"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get firm estimates","tags":["estimates"]}},"/estimates/get_report_documents":{"post":{"description":"Full text (Markdown) of analyst reports by analysis_id, with report metadata. IDs without a document for the customer are listed in missing_analysis_ids. Requires the Monitor estimates product.","operationId":"get_report_documents","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"analysis_ids":{"description":"Required: 1–50 report IDs from list_analyst_reports or search_report_documents. Duplicate IDs are fetched once.","items":{"type":"integer"},"maxItems":50,"minItems":1,"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":5,"description":"Page size: maximum number of analysis_ids fetched per call, 1-50, default 5. The remaining IDs are fetched with next_cursor.","maximum":50,"minimum":1,"type":["integer","null"]}},"required":["analysis_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"documents":{"items":{"additionalProperties":false,"properties":{"analysis_date":{"description":"Report date, YYYY-MM-DD","type":"string"},"analysis_id":{"description":"Report ID; join to list_analyst_reports and get_report_estimates by analysis_id","type":"integer"},"analysis_type":{"type":["string","null"]},"analysts":{"description":"Report analysts; null when report metadata is unavailable","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID of the analyst, shared with CRM persons; null when the analyst is not indexed","type":["string","null"]},"first_name":{"type":"string"},"last_name":{"type":"string"}},"required":["contact_id","first_name","last_name"],"type":"object"},"type":"array"},"content":{"description":"Full markdown content of the report document","type":"string"},"firm_name":{"description":"Research firm name; null when report metadata is unavailable","type":["string","null"]},"firm_party_id":{"description":"Analysis firm party ID; null when the document carries no firm","type":["string","null"]},"name":{"description":"Report name; null when report metadata is unavailable","type":["string","null"]},"recommendation":{"type":["string","null"]},"report_document_id":{"description":"ID of the uploaded report file","type":"string"},"target_price":{"type":["number","null"]},"target_price_currency":{"type":["string","null"]}},"required":["name","firm_name","analysts","analysis_type","recommendation","target_price","target_price_currency","analysis_id","report_document_id","analysis_date","firm_party_id","content"],"type":"object"},"type":"array"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"missing_analysis_ids":{"description":"Requested report IDs with no document for this customer","items":{"type":"integer"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["missing_analysis_ids","documents","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get report documents"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get report documents","tags":["estimates"]}},"/estimates/get_report_estimates":{"post":{"description":"Estimate rows per KPI and fiscal period from specific analyst reports, selected by analysis_ids (up to 500) or by query on report date, firm, analyst or type. Omit customer_kpi_ids for all active KPIs. For each firm's current forecasts use get_firm_estimates. Requires the Monitor estimates product.","operationId":"get_report_estimates","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"analysis_ids":{"description":"Up to 500 report IDs; omit, null or empty to select reports using query alone. Nonempty IDs narrow the reports before query filters, sorting and pagination; IDs outside the customer catalog are reported as missing.","items":{"type":"integer"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"customer_kpi_ids":{"description":"Omit, null or empty for all active customer KPIs (enabled for actuals or estimates)","items":{"type":"string"},"type":"array"},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of estimates entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional report selection, used when analysis_ids is empty. where is an AND list of {field, op, value} predicates on report fields such as analysis_date, firm_party_id, analyst_contact_id, analysis_type or recommendation; sort orders the selected reports.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["analysis_date","analysis_id","analysis_type","firm_name","firm_party_id","name","recommendation","target_price"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["analysis_date","analysis_type","analyst_contact_id","firm_name","firm_party_id","name","recommendation","target_price"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"estimates":{"items":{"additionalProperties":false,"properties":{"analysis_date":{"type":"string"},"analysis_id":{"type":"integer"},"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"display_scale":{"description":"Display divisor; for percent, multiply value/display_scale by 100 and append %","type":"integer"},"firm_name":{"type":"string"},"firm_party_id":{"description":"Analysis firm party ID","type":["string","null"]},"fiscal_quarter":{"description":"Backend fiscal quarter, null for full year; period retains half-year reporter labels","type":["integer","null"]},"fiscal_year":{"type":"integer"},"group_name":{"type":["string","null"]},"kpi_name":{"type":"string"},"period":{"type":"string"},"snapshot_date":{"type":["string","null"]},"unit":{"description":"KPI unit; percent means a fraction (1 = 100%)","type":"string"},"value":{"description":"Numeric value: percentage KPIs use fractions (0.042 = 4.2%); other KPIs use base units; null if missing","type":["number","null"]}},"required":["customer_kpi_id","kpi_name","fiscal_year","fiscal_quarter","period","value","unit","currency","display_scale","firm_party_id","firm_name","analysis_id","analysis_date"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["estimates","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get report estimates"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Get report estimates","tags":["estimates"]}},"/estimates/list_analyst_reports":{"post":{"description":"Analyst research reports collected for the customer, newest first, with analysis_id, date, firm, analysts, recommendation, target price and whether a document is available. Use get_report_estimates for the forecasts and get_report_documents or search_report_documents for the text. Requires the Monitor estimates product.","operationId":"list_analyst_reports","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"analysis_ids":{"description":"Positive analysis IDs from report results, up to 500. Omit, null or empty for all available reports. IDs narrow the scope before query filtering, sorting and pagination; duplicates do not duplicate reports. IDs not among the customer's reports return no rows.","items":{"type":"integer"},"maxItems":500,"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of reports entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: analysis_date (date; eq, ne, in, gt, gte, lt, lte), analysis_type (string; eq, ne, in, contains), analyst_contact_id (string; eq, in), firm_name (string; eq, ne, in, contains), firm_party_id (string; eq, ne, in), has_document (boolean; eq, in), name (string; eq, ne, in, contains), recommendation (string; eq, ne, in, contains), target_price (number; eq, ne, in, gt, gte, lt, lte). sort is a list of {field, desc} on: analysis_date, analysis_id, analysis_type, firm_name, firm_party_id, name, recommendation, target_price.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["analysis_date","analysis_id","analysis_type","firm_name","firm_party_id","name","recommendation","target_price"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["analysis_date","analysis_type","analyst_contact_id","firm_name","firm_party_id","has_document","name","recommendation","target_price"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"reports":{"items":{"additionalProperties":false,"properties":{"analysis_date":{"type":"string"},"analysis_id":{"type":"integer"},"analysis_type":{"type":["string","null"]},"analysts":{"items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID of the analyst, shared with CRM persons; null when the analyst is not indexed","type":["string","null"]},"first_name":{"type":"string"},"last_name":{"type":"string"}},"required":["contact_id","first_name","last_name"],"type":"object"},"type":"array"},"firm_name":{"type":"string"},"firm_party_id":{"description":"Analysis firm party ID","type":["string","null"]},"has_document":{"description":"Whether an uploaded report document exists; null when document availability could not be determined. False means a successful lookup found no document.","type":["boolean","null"]},"name":{"type":"string"},"recommendation":{"type":"string"},"target_price":{"type":["number","null"]},"target_price_currency":{"type":["string","null"]},"valid_to":{"description":"Date the report stops counting towards the consensus; null when it has no end date","type":["string","null"]}},"required":["has_document","name","analysis_id","analysis_date","analysis_type","recommendation","target_price","target_price_currency","valid_to","analysts","firm_party_id","firm_name"],"type":"object"},"type":"array"}},"required":["reports","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List analyst reports"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"List analyst reports","tags":["estimates"]}},"/estimates/list_kpi_types":{"post":{"description":"The customer's configured estimate KPIs with customer_kpi_id, name, group, unit, whether they are used for estimates or actuals, and monitor_idx, the display order in Monitor. Requires the Monitor estimates product.","operationId":"list_kpi_types","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":50,"description":"Page size: maximum number of kpi_types entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: currency (string; eq, ne, in, contains), group_name (string; eq, ne, in, contains), in_use_actuals (boolean; eq, ne, in), in_use_estimates (boolean; eq, ne, in), kpi_name (string; eq, ne, in, contains), monitor_idx (integer; eq, ne, in, gt, gte, lt, lte), unit (string; eq, ne, in, contains). sort is a list of {field, desc} on: currency, group_name, in_use_actuals, in_use_estimates, kpi_name, monitor_idx, unit.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["currency","group_name","in_use_actuals","in_use_estimates","kpi_name","monitor_idx","unit"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["currency","group_name","in_use_actuals","in_use_estimates","kpi_name","monitor_idx","unit"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["language"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"kpi_types":{"items":{"additionalProperties":false,"properties":{"currency":{"type":["string","null"]},"customer_kpi_id":{"type":"string"},"decimals":{"description":"Decimal places, or significant digits when value_format is double_significant","type":"integer"},"display_scale":{"type":"integer"},"group_name":{"type":["string","null"]},"in_use_actuals":{"type":"boolean"},"in_use_estimates":{"type":"boolean"},"kpi_name":{"type":"string"},"monitor_idx":{"description":"Zero-based position in the customer's monitor KPI ordering among KPIs used for estimates. Join by customer_kpi_id and sort ascending, nulls last. Null for KPIs not used for estimates.","type":["integer","null"]},"unit":{"type":"string"},"value_format":{"description":"Presentation format for value/display_scale; percent uses fractional input","type":"string"}},"required":["monitor_idx","value_format","decimals","customer_kpi_id","kpi_name","unit","currency","display_scale","in_use_actuals","in_use_estimates"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["kpi_types","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List KPI types"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"List KPI types","tags":["estimates"]}},"/estimates/search_report_documents":{"post":{"description":"Semantic search over the text of the customer's analyst reports. Returns matching passages with report metadata (analysis_id, date, firm, analysts, recommendation, target price). The nearest passages are always returned, so check their relevance. Optionally restrict to reports, firms or a date range. Read whole reports with get_report_documents. Requires the Monitor estimates product.","operationId":"search_report_documents","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"analysis_ids":{"description":"Optional: restrict the search to up to 100 report IDs; omit, null or empty means no report ID filter","items":{"type":"integer"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Inclusive lower bound on the report date, YYYY-MM-DD","format":"date","type":["string","null"]},"language":{"enum":["en","sv"],"type":"string"},"limit":{"default":10,"description":"Page size: maximum number of chunks entries, 1-100, default 10.","maximum":100,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Optional: analysis firm party IDs from list_analyst_reports; only their report documents are searched. Omit, null or empty means no firm filter","items":{"type":"string"},"type":"array"},"search":{"description":"Natural-language query; a short, specific topic works best.","type":"string"},"to":{"description":"Inclusive upper bound on the report date, YYYY-MM-DD","format":"date","type":["string","null"]}},"required":["search"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"chunks":{"items":{"additionalProperties":false,"properties":{"analysis_date":{"description":"Report date, YYYY-MM-DD","type":"string"},"analysis_id":{"description":"Report ID; join to list_analyst_reports and get_report_estimates by analysis_id","type":"integer"},"analysis_type":{"type":["string","null"]},"analysts":{"description":"Report analysts; null when report metadata is unavailable","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID of the analyst, shared with CRM persons; null when the analyst is not indexed","type":["string","null"]},"first_name":{"type":"string"},"last_name":{"type":"string"}},"required":["contact_id","first_name","last_name"],"type":"object"},"type":"array"},"chunk_id":{"description":"Chunk index within the report document; identify a chunk by report_document_id and chunk_id together, never chunk_id alone","type":"integer"},"content":{"description":"Chunk text","type":"string"},"firm_name":{"description":"Research firm name; null when report metadata is unavailable","type":["string","null"]},"firm_party_id":{"description":"Analysis firm party ID; null when the document carries no firm","type":["string","null"]},"name":{"description":"Report name; null when report metadata is unavailable","type":["string","null"]},"recommendation":{"type":["string","null"]},"report_document_id":{"description":"ID of the uploaded report file","type":"string"},"target_price":{"type":["number","null"]},"target_price_currency":{"type":["string","null"]}},"required":["name","firm_name","analysts","analysis_type","recommendation","target_price","target_price_currency","analysis_id","report_document_id","analysis_date","firm_party_id","chunk_id","content"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["chunks","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Search report documents"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:estimates.read"]}],"summary":"Search report documents","tags":["estimates"]}},"/market/get_market_cap_history":{"post":{"description":"Market capitalisation history for one or more companies. from and to are inclusive and default to all history up to today.","operationId":"get_market_cap_history","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select; 1–1000 IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Inclusive history start; defaults to 1900-01-01","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of mcap entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: amount (number; eq, ne, gt, gte, lt, lte), at (date; eq, ne, gt, gte, lt, lte), currency (string; eq, ne, in, contains). sort is a list of {field, desc} on: amount, at, currency. search is a text match on: currency.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["amount","at","currency"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["amount","at","currency"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Inclusive history end; defaults to today in UTC","format":"date","type":["string","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"mcap":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"Market capitalization in full currency units; null when unavailable","type":["number","null"]},"at":{"format":"date","type":["string","null"]},"company_party_id":{"description":"Issuer party ID; null when not indexed","type":["string","null"]},"currency":{"description":"Currency of the amounts: the user's Monitor currency setting","type":"string"}},"required":["company_party_id","amount","at","currency"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["mcap","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get market cap history"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"Get market cap history","tags":["market"]}},"/market/get_short_interest_history":{"post":{"description":"Aggregate short interest history for up to 50 companies, one row per company and date. Public, anonymous and total (public plus anonymous) short interest each have capital fraction (0-1), shares and value.","operationId":"get_short_interest_history","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties whose aggregate short history is wanted; 1–50 IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Inclusive start; omit for all available history","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of history entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: at (date; eq, ne, gt, gte, lt, lte, in), company_country (string; eq, ne, in, contains), company_name (string; eq, ne, in, contains), short_anonymous_capital (number; eq, ne, gt, gte, lt, lte), short_anonymous_shares (integer; eq, ne, gt, gte, lt, lte), short_anonymous_value (number; eq, ne, gt, gte, lt, lte), short_public_capital (number; eq, ne, gt, gte, lt, lte), short_public_shares (integer; eq, ne, gt, gte, lt, lte), short_public_value (number; eq, ne, gt, gte, lt, lte), short_total_capital (number; eq, ne, gt, gte, lt, lte), short_total_shares (integer; eq, ne, gt, gte, lt, lte), short_total_value (number; eq, ne, gt, gte, lt, lte). sort is a list of {field, desc} on: at, company_country, company_name, short_anonymous_capital, short_anonymous_shares, short_anonymous_value, short_public_capital, short_public_shares, short_public_value, short_total_capital, short_total_shares, short_total_value. search is a text match on: company_country, company_name. company_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["at","company_country","company_name","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_public_capital","short_public_shares","short_public_value","short_total_capital","short_total_shares","short_total_value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["at","company_country","company_name","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_public_capital","short_public_shares","short_public_value","short_total_capital","short_total_shares","short_total_value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Inclusive end; defaults to today","format":"date","type":["string","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"history":{"items":{"additionalProperties":false,"properties":{"at":{"format":"date","type":"string"},"company_country":{"type":"string"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party; null when not indexed","type":["string","null"]},"industry_id":{"type":["integer","null"]},"industry_name":{"type":["string","null"]},"name":{"type":"string"},"sector_id":{"type":["integer","null"]},"sector_name":{"type":["string","null"]},"short_anonymous_capital":{"type":["number","null"]},"short_anonymous_currency":{"type":["string","null"]},"short_anonymous_shares":{"type":["integer","null"]},"short_anonymous_value":{"type":["number","null"]},"short_anonymous_verified_at":{"type":["string","null"]},"short_public_capital":{"type":["number","null"]},"short_public_currency":{"type":["string","null"]},"short_public_shares":{"type":["integer","null"]},"short_public_value":{"type":["number","null"]},"short_public_verified_at":{"type":["string","null"]},"short_total_capital":{"type":["number","null"]},"short_total_currency":{"type":["string","null"]},"short_total_shares":{"type":["integer","null"]},"short_total_value":{"type":["number","null"]},"short_total_verified_at":{"type":["string","null"]},"stock_id":{"description":"Present for security-level rows; absent for company aggregate history","type":["integer","null"]},"symbol":{"type":"string"}},"required":["company_party_id","company_name","company_country","industry_id","industry_name","sector_id","sector_name","at","short_total_capital","short_total_shares","short_total_value","short_total_currency","short_total_verified_at","short_public_capital","short_public_shares","short_public_value","short_public_currency","short_public_verified_at","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_anonymous_currency","short_anonymous_verified_at"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["history","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get short interest history"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"Get short interest history","tags":["market"]}},"/market/get_stock_prices":{"post":{"description":"Daily open, high, low and close prices in trading currency for the stocks of the selected companies. Omit from and to for the latest observation per stock, or give both for daily history (inclusive). Optional stock_ids narrow to specific share classes.","operationId":"get_stock_prices","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select; 1–1000 IDs, or omit when stock_ids identifies the shares","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Inclusive history start; provide together with to, or omit both for latest OHLC","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of prices entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: close (number; eq, ne, gt, gte, lt, lte), company_name (string; eq, ne, in, contains), currency (string; eq, ne, in, contains), date (date; eq, ne, gt, gte, lt, lte), high (number; eq, ne, gt, gte, lt, lte), low (number; eq, ne, gt, gte, lt, lte), open (number; eq, ne, gt, gte, lt, lte), stock_id (integer; eq, ne, gt, gte, lt, lte), symbol (string; eq, ne, in, contains). sort is a list of {field, desc} on: close, company_name, currency, date, high, low, open, stock_id, symbol. search is a text match on: company_name, currency, symbol.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["close","company_name","currency","date","high","low","open","stock_id","symbol"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["close","company_name","currency","date","high","low","open","stock_id","symbol"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"stock_ids":{"description":"Stock selection; with company_party_ids it restricts share classes, alone it selects the stocks and their issuers are resolved. Omit for all share classes of the companies","items":{"type":"integer"},"type":"array"},"to":{"description":"Inclusive history end; required with from","format":"date","type":["string","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"prices":{"items":{"additionalProperties":false,"properties":{"close":{"type":["number","null"]},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null when not indexed","type":["string","null"]},"currency":{"type":"string"},"date":{"description":"Observation date; null when latest data is unavailable","format":"date","type":["string","null"]},"high":{"type":["number","null"]},"low":{"type":["number","null"]},"open":{"type":["number","null"]},"stock_id":{"type":"integer"},"symbol":{"type":"string"}},"required":["company_party_id","company_name","stock_id","symbol","currency","date","open","high","low","close"],"type":"object"},"type":"array"}},"required":["prices","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get stock prices"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"Get stock prices","tags":["market"]}},"/market/list_block_trades":{"post":{"description":"Block trades in the stocks of the selected companies, newest first, with buying and selling broker, shares, price in trading currency, value and share of capital. from and to are inclusive.","operationId":"list_block_trades","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select; 1–1000 IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of blocks entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: at (datetime; eq, ne, gt, gte, lt, lte, in), buyer (string; eq, ne, in, contains), capital (number; eq, ne, gt, gte, lt, lte), company_name (string; eq, ne, in, contains), price (number; eq, ne, gt, gte, lt, lte), seller (string; eq, ne, in, contains), shares (integer; eq, ne, gt, gte, lt, lte), stock_id (integer; eq, ne, gt, gte, lt, lte), stock_symbol (string; eq, ne, in, contains), value (number; eq, ne, gt, gte, lt, lte). sort is a list of {field, desc} on: at, capital, company_name, price, shares, stock_id, stock_symbol, value. search is a text match on: buyer, company_name, seller, stock_symbol.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["at","capital","company_name","price","shares","stock_id","stock_symbol","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["at","buyer","capital","company_name","price","seller","shares","stock_id","stock_symbol","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Inclusive end date; defaults to the current UTC time when omitted","format":"date","type":["string","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"blocks":{"items":{"additionalProperties":false,"properties":{"at":{"format":"date-time","type":["string","null"]},"buyer":{"description":"Buyer bank symbol, not a holder identity","type":["string","null"]},"capital":{"type":["number","null"]},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null when not indexed","type":["string","null"]},"price":{"type":["number","null"]},"price_currency":{"type":["string","null"]},"seller":{"description":"Seller bank symbol, not a holder identity","type":["string","null"]},"shares":{"type":"integer"},"stock_id":{"description":"Stock associated with the block trade; trades without a stock are excluded","type":"integer"},"stock_symbol":{"type":"string"},"value":{"type":["number","null"]},"value_currency":{"type":["string","null"]}},"required":["company_party_id","company_name","at","capital","shares","buyer","seller","price","price_currency","value","value_currency","stock_id","stock_symbol"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["blocks","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List block trades"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List block trades","tags":["market"]}},"/market/list_buyback_programs":{"post":{"description":"Past and current share buyback mandates for the selected companies, with maximum shares and value, progress so far and validity dates.","operationId":"list_buyback_programs","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select; 1–1000 IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of repurchase_programs entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_name (string; eq, ne, in, contains), max_shares (integer; eq, ne, gt, gte, lt, lte), max_value (number; eq, ne, gt, gte, lt, lte), shares_repurchased (integer; eq, ne, gt, gte, lt, lte), shares_repurchased_percent (number; eq, ne, gt, gte, lt, lte), valid_from (date; eq, ne, gt, gte, lt, lte, in), valid_to (date; eq, ne, gt, gte, lt, lte, in), value_repurchased (number; eq, ne, gt, gte, lt, lte), value_repurchased_percent (number; eq, ne, gt, gte, lt, lte). sort is a list of {field, desc} on: company_name, max_shares, max_value, shares_repurchased, shares_repurchased_percent, valid_from, valid_to, value_repurchased, value_repurchased_percent. search is a text match on: company_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["company_name","max_shares","max_value","shares_repurchased","shares_repurchased_percent","valid_from","valid_to","value_repurchased","value_repurchased_percent"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_name","max_shares","max_value","shares_repurchased","shares_repurchased_percent","valid_from","valid_to","value_repurchased","value_repurchased_percent"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"repurchase_programs":{"items":{"additionalProperties":false,"properties":{"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null when not indexed","type":["string","null"]},"max_shares":{"type":["integer","null"]},"max_value":{"type":["number","null"]},"max_value_currency":{"type":["string","null"]},"shares_repurchased":{"type":["integer","null"]},"shares_repurchased_percent":{"type":["number","null"]},"valid_from":{"type":["string","null"]},"valid_to":{"type":["string","null"]},"value_repurchased":{"type":["number","null"]},"value_repurchased_currency":{"type":["string","null"]},"value_repurchased_percent":{"type":["number","null"]},"vwap":{"type":["number","null"]},"vwap_currency":{"type":["string","null"]}},"required":["company_party_id","company_name","valid_from","valid_to","max_shares","max_value","max_value_currency","shares_repurchased","value_repurchased","value_repurchased_currency","shares_repurchased_percent","value_repurchased_percent","vwap","vwap_currency"],"type":"object"},"type":"array"}},"required":["repurchase_programs","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List buyback programs"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List buyback programs","tags":["market"]}},"/market/list_buyback_transactions":{"post":{"description":"Individual share buyback executions for the selected companies, newest first, with shares, price in trading currency and change in capital. from and to filter inclusive calendar dates.","operationId":"list_buyback_transactions","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select; 1–1000 IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of repurchase_transactions entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_name (string; eq, ne, in, contains), delta_capital (number; eq, ne, gt, gte, lt, lte), delta_shares (integer; eq, ne, gt, gte, lt, lte), price (number; eq, ne, gt, gte, lt, lte), price_currency (string; eq, in), repurchase_date (datetime; eq, ne, gt, gte, lt, lte, in), stock_symbol (string; eq, ne, in, contains). sort is a list of {field, desc} on: company_name, delta_capital, delta_shares, price, repurchase_date, stock_symbol. search is a text match on: company_name, stock_symbol.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["company_name","delta_capital","delta_shares","price","repurchase_date","stock_symbol"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_name","delta_capital","delta_shares","price","price_currency","repurchase_date","stock_symbol"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"format":"date","type":["string","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"repurchase_transactions":{"items":{"additionalProperties":false,"properties":{"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null when not indexed","type":["string","null"]},"delta_capital":{"type":["number","null"]},"delta_shares":{"type":["integer","null"]},"price":{"type":["number","null"]},"price_currency":{"type":["string","null"]},"repurchase_date":{"format":"date-time","type":"string"},"stock_id":{"type":["integer","null"]},"stock_symbol":{"type":["string","null"]}},"required":["company_party_id","company_name","repurchase_date","delta_capital","delta_shares","price","price_currency","stock_id","stock_symbol"],"type":"object"},"type":"array"}},"required":["repurchase_transactions","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List buyback transactions"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List buyback transactions","tags":["market"]}},"/market/list_calendar_events":{"post":{"description":"Corporate calendar events (reports, general meetings, capital market days, dividends, splits) for one or more companies, with date and event name. from and to are inclusive; omit them to include all past and future events.","operationId":"list_calendar_events","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Select 1–1000 canonical company party IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Earliest event date to include, inclusive. Omit to include past events","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of events entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_name (string; eq, in, contains), date (date; eq, ne, gt, gte, lt, lte, in), event_name (string; eq, ne, in, contains). sort is a list of {field, desc} on: company_name, date, event_name. search is a text match on: company_name, event_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["company_name","date","event_name"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_name","date","event_name"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Latest event date to include, inclusive. Omit to include all future events","format":"date","type":["string","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"events":{"items":{"additionalProperties":false,"properties":{"company_name":{"type":"string"},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"date":{"type":"string"},"event_name":{"type":"string"}},"required":["company_party_id","company_name","date","event_name"],"type":"object"},"type":"array"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["events","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List calendar events"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List calendar events","tags":["market"]}},"/market/list_companies":{"post":{"description":"Screen or search listed companies. Returns company metadata, market cap and currency, sector, industry, free float, address, description, primary market segment and current CEO and chairman. Filter by country, sector, industry, market segment or market cap, or search by name or ticker with query.search. Default order is text relevance when searching, otherwise market cap descending.","operationId":"list_companies","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"description":"As-of date for market cap and free float, defaults to today","format":"date","type":["string","null"]},"company_party_ids":{"description":"Restrict the screen to these issuer party IDs.","items":{"type":"string"},"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of companies entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: industry_id (integer; eq, in), market_country (string; eq, in), market_segment_id (integer; eq, in), mcap (money; gte, lte), sector_id (integer; eq, in). Money values are {amount, currency} objects. sort is a list of {field, desc} on: mcap, name, text_match. search is a text match on: name. industry_id, sector_id: numeric ID or unique catalog name from list_industries or list_sectors. market_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions. market_segment_id: numeric ID or unique name or symbol from list_market_segments.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["mcap","name","text_match"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["industry_id","market_country","market_segment_id","mcap","sector_id"],"type":"string"},"op":{"enum":["eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"companies":{"description":"List of companies matching the filters","items":{"additionalProperties":false,"properties":{"address":{"type":["string","null"]},"ceo_name":{"type":["string","null"]},"chairman_name":{"type":["string","null"]},"city":{"type":["string","null"]},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"country":{"type":["string","null"]},"currency":{"type":["string","null"]},"description":{"type":["string","null"]},"free_float_capital":{"type":["number","null"]},"free_float_date":{"type":["string","null"]},"free_float_shares":{"type":["integer","null"]},"industry_id":{"type":["integer","null"]},"industry_name":{"type":["string","null"]},"lei":{"type":["string","null"]},"market_country":{"type":["string","null"]},"market_currency":{"type":["string","null"]},"market_segment_id":{"type":["integer","null"]},"market_segment_name":{"type":["string","null"]},"market_segment_symbol":{"type":["string","null"]},"mcap":{"type":["number","null"]},"mcap_currency":{"type":["string","null"]},"name":{"type":["string","null"]},"sector_id":{"type":["integer","null"]},"sector_name":{"type":["string","null"]},"zip":{"type":["string","null"]}},"required":["company_party_id","name","lei","currency","country","address","city","zip","description","mcap","mcap_currency","free_float_shares","free_float_capital","free_float_date","sector_id","sector_name","industry_id","industry_name","market_segment_id","market_segment_name","market_segment_symbol","market_country","market_currency","ceo_name","chairman_name"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["companies","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List companies"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List companies","tags":["market"]}},"/market/list_industries":{"post":{"description":"List all industries with industry_id and name, for industry filters in other tools.","operationId":"list_industries","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"industries":{"description":"List of industries","items":{"additionalProperties":false,"properties":{"industry_id":{"type":"integer"},"name":{"type":"string"}},"required":["industry_id","name"],"type":"object"},"type":"array"}},"required":["industries"],"type":"object"}}},"description":"List industries"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List industries","tags":["market"]}},"/market/list_insider_transactions":{"post":{"description":"Reported insider transactions for one or more companies, newest first. Each row has the insider and owner, stock, transaction time, signed share change, resulting holding, price and currency. Without a transaction_date filter the last 365 days are returned; filter on transaction_date (YYYY-MM-DD) to reach further back, up to about 27 years.","operationId":"list_insider_transactions","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Select 1–1000 canonical company party IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of insider_transactions entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_name (string; eq, in, contains), currency (string; eq, in), delta_shares (integer; eq, ne, gt, gte, lt, lte), insider_name (string; eq, ne, in, contains), owner_name (string; eq, ne, in, contains), share_price (number; eq, gt, gte, lt, lte), transaction_date (date; eq, gt, gte, lt, lte, in). sort is a list of {field, desc} on: company_name, delta_shares, insider_name, owner_name, share_price, transaction_date. search is a text match on: company_name, insider_name, owner_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["company_name","delta_shares","insider_name","owner_name","share_price","transaction_date"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_name","currency","delta_shares","insider_name","owner_name","share_price","transaction_date"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"insider_transactions":{"items":{"additionalProperties":false,"properties":{"company_name":{"type":"string"},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"currency":{"type":["string","null"]},"delta_shares":{"type":["integer","null"]},"insider_name":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Canonical party ID of the transaction owner","type":["string","null"]},"share_price":{"type":["number","null"]},"stock_holding":{"type":["integer","null"]},"stock_id":{"type":["integer","null"]},"stock_symbol":{"type":["string","null"]},"transaction_date":{"type":["string","null"]}},"required":["company_party_id","company_name","owner_party_id","owner_name","stock_id","stock_symbol","insider_name","transaction_date","delta_shares","stock_holding","share_price","currency"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["insider_transactions","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List insider transactions"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List insider transactions","tags":["market"]}},"/market/list_market_segments":{"post":{"description":"List all market segments (lists such as Nasdaq Stockholm Large Cap) with ID, name, symbol, country and currency, for market segment filters in other tools.","operationId":"list_market_segments","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"market_segments":{"description":"List of market segments","items":{"additionalProperties":false,"properties":{"country":{"type":"string"},"currency":{"type":"string"},"market_segment_id":{"type":"integer"},"market_segment_name":{"type":"string"},"market_segment_symbol":{"type":"string"}},"required":["market_segment_id","market_segment_name","market_segment_symbol","country","currency"],"type":"object"},"type":"array"}},"required":["market_segments"],"type":"object"}}},"description":"List market segments"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List market segments","tags":["market"]}},"/market/list_sectors":{"post":{"description":"List all sectors with sector_id and name, for sector filters in other tools.","operationId":"list_sectors","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"sectors":{"description":"List of sectors","items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"sector_id":{"type":"integer"}},"required":["sector_id","name"],"type":"object"},"type":"array"}},"required":["sectors"],"type":"object"}}},"description":"List sectors"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List sectors","tags":["market"]}},"/market/list_short_holders":{"post":{"description":"Search or select holders of disclosed short positions. Each row summarises one holder at a date (default today): value and number of positions, the shorted stock_ids and the return on its positions. Use query.search to find holders by name.","operationId":"list_short_holders","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"date":{"description":"Summary date; defaults to today","format":"date","type":["string","null"]},"has_short_position_at_date":{"description":"Only holders with an active position on this date","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of holders entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Short holders to select; omit to search all holders; at most 50","items":{"type":"string"},"type":"array"},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: holder_name (string; eq, ne, in, contains), holdings_value (number; eq, ne, gt, gte, lt, lte), num_of_holdings (integer; eq, ne, gt, gte, lt, lte, in), positions_return (number; eq, ne, gt, gte, lt, lte), verified (datetime; eq, ne, gt, gte, lt, lte, in). sort is a list of {field, desc} on: holder_name, holdings_value, num_of_holdings, positions_return, verified. search is a text match on: holder_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["holder_name","holdings_value","num_of_holdings","positions_return","verified"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["holder_name","holdings_value","num_of_holdings","positions_return","verified"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"holders":{"items":{"additionalProperties":false,"properties":{"holder_name":{"type":"string"},"holdings_value":{"type":"number"},"num_of_holdings":{"type":"integer"},"party_id":{"description":"Canonical party ID; null when the holder is not indexed","type":["string","null"]},"positions_return":{"type":"number"},"stock_ids":{"items":{"type":"integer"},"type":"array"},"verified":{"type":"string"}},"required":["party_id","holder_name","holdings_value","stock_ids","num_of_holdings","verified","positions_return"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["holders","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List short holders"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List short holders","tags":["market"]}},"/market/list_short_position_changes":{"post":{"description":"Recorded changes in publicly disclosed short positions for given companies, holders or their intersection, newest first. Each row has the position after the change, signed changes in shares, capital and value, and the publication time. At least one of company_party_ids and holder_party_ids is required.","operationId":"list_short_position_changes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select, at most 50","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"format":"date","type":["string","null"]},"holder_party_ids":{"description":"Short holder parties to select, at most 50; at least one side required","items":{"type":"string"},"type":"array"},"limit":{"default":50,"description":"Page size: maximum number of transactions entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: capital (number; eq, ne, gt, gte, lt, lte), company_name (string; eq, ne, in, contains), delta_capital (number; eq, ne, gt, gte, lt, lte), delta_shares (integer; eq, ne, gt, gte, lt, lte), delta_value (number; eq, ne, gt, gte, lt, lte), holder_name (string; eq, ne, in, contains), publication_date (datetime; eq, ne, gt, gte, lt, lte, in), shares (integer; eq, ne, gt, gte, lt, lte), valid_from (date; eq, ne, gt, gte, lt, lte, in). sort is a list of {field, desc} on: capital, company_name, delta_capital, delta_shares, delta_value, holder_name, publication_date, shares, valid_from. search is a text match on: company_name, holder_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["capital","company_name","delta_capital","delta_shares","delta_value","holder_name","publication_date","shares","valid_from"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["capital","company_name","delta_capital","delta_shares","delta_value","holder_name","publication_date","shares","valid_from"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"format":"date","type":["string","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"transactions":{"description":"Public short position changes","items":{"additionalProperties":false,"properties":{"capital":{"description":"Holder's short position after the transaction, as a fraction (0-1) of the company's share capital","type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party; null when not indexed","type":["string","null"]},"delta_capital":{"type":"number"},"delta_currency":{"description":"Currency of delta_value, from the user's Monitor currency setting","type":"string"},"delta_shares":{"type":"integer"},"delta_value":{"description":"Value of the transaction","type":"number"},"holder_name":{"description":"The name of the short holder","type":"string"},"holder_party_id":{"description":"Canonical party ID; null when the holder is not indexed","type":["string","null"]},"publication_date":{"description":"Date when the transaction was published","format":"date-time","type":"string"},"shares":{"description":"Number of shares shorted by the holder, after the transaction","type":"integer"},"stock_id":{"type":"integer"},"stock_name":{"type":"string"},"stock_symbol":{"type":"string"},"valid_from":{"description":"Date of the transaction","format":"date","type":"string"},"vwap":{"description":"Volume Weighted Average Price of the transaction","type":"number"},"vwap_currency":{"description":"Currency of vwap","type":"string"}},"required":["holder_party_id","company_party_id","company_name","stock_name","stock_symbol","vwap_currency","holder_name","stock_id","delta_shares","delta_capital","shares","capital","delta_value","vwap","delta_currency","valid_from","publication_date"],"type":"object"},"type":"array"}},"required":["transactions","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List short position changes"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List short position changes","tags":["market"]}},"/market/list_short_positions":{"post":{"description":"Publicly disclosed short positions at a date (default today) for given holders, companies or their intersection. Each row has the company, holder and stock, shares, capital fraction (0-1), value and latest change. At least one of company_party_ids and holder_party_ids is required.","operationId":"list_short_positions","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Issuer parties to select, at most 50; combined with holders selects their intersection","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"date":{"description":"Position date; defaults to today","format":"date","type":["string","null"]},"holder_party_ids":{"description":"Short-holder parties to select, at most 50; at least one side is required","items":{"type":"string"},"type":"array"},"limit":{"default":50,"description":"Page size: maximum number of positions entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: capital (number; eq, ne, gt, gte, lt, lte), company_name (string; eq, ne, in, contains), delta_capital (number; eq, ne, gt, gte, lt, lte), holder_name (string; eq, ne, in, contains), shares (integer; eq, ne, gt, gte, lt, lte), stock_name (string; eq, ne, in, contains), stock_symbol (string; eq, ne, in, contains), valid_from (date; eq, ne, gt, gte, lt, lte, in), value (number; eq, ne, gt, gte, lt, lte). sort is a list of {field, desc} on: capital, company_name, delta_capital, holder_name, shares, stock_name, stock_symbol, valid_from, value. search is a text match on: company_name, holder_name, stock_name, stock_symbol.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["capital","company_name","delta_capital","holder_name","shares","stock_name","stock_symbol","valid_from","value"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["capital","company_name","delta_capital","holder_name","shares","stock_name","stock_symbol","valid_from","value"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"positions":{"items":{"additionalProperties":false,"properties":{"capital":{"description":"Short fraction (0–1) of company capital","type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party; null when not indexed","type":["string","null"]},"currency":{"type":"string"},"delta_capital":{"type":"number"},"holder_name":{"type":"string"},"holder_party_id":{"description":"Short holder party; null when not indexed","type":["string","null"]},"shares":{"type":"integer"},"stock_id":{"type":"integer"},"stock_name":{"type":"string"},"stock_symbol":{"type":"string"},"valid_from":{"description":"Date of the last reported position change","format":"date","type":"string"},"value":{"type":"number"}},"required":["company_party_id","holder_party_id","company_name","holder_name","stock_id","stock_name","stock_symbol","shares","capital","delta_capital","valid_from","value","currency"],"type":"object"},"type":"array"}},"required":["positions","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List short positions"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List short positions","tags":["market"]}},"/market/list_shorted_stocks":{"post":{"description":"Market-wide screen of shorted stocks at a date (default today), by default ordered by total short interest descending. Each row has company, sector and industry plus public, anonymous and total short interest as capital fractions (0-1), shares and value. Filter by country, market segment, sector, industry or short metrics.","operationId":"list_shorted_stocks","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Optional issuer parties to screen, at most 50","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"date":{"description":"Date of the short data, defaults to today","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of shorted_stocks entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: at (date; eq, ne, gt, gte, lt, lte, in), company_country (string; eq, in), company_name (string; eq, ne, in, contains), industry_id (integer; eq, in), market_segment_id (integer; eq, in), name (string; eq, ne, in, contains), sector_id (integer; eq, in), short_anonymous_capital (number; eq, ne, gt, gte, lt, lte), short_anonymous_shares (integer; eq, ne, gt, gte, lt, lte), short_anonymous_value (number; eq, ne, gt, gte, lt, lte), short_public_capital (number; eq, ne, gt, gte, lt, lte), short_public_shares (integer; eq, ne, gt, gte, lt, lte), short_public_value (number; eq, ne, gt, gte, lt, lte), short_total_capital (number; eq, ne, gt, gte, lt, lte), short_total_shares (integer; eq, ne, gt, gte, lt, lte), short_total_value (number; eq, ne, gt, gte, lt, lte), symbol (string; eq, ne, in, contains). sort is a list of {field, desc} on: at, company_country, company_name, name, sector_id, short_anonymous_capital, short_anonymous_shares, short_anonymous_value, short_public_capital, short_public_shares, short_public_value, short_total_capital, short_total_shares, short_total_value, symbol. search is a text match on: company_name, name, symbol. company_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions. industry_id, sector_id: numeric ID or unique catalog name from list_industries or list_sectors. market_segment_id: numeric ID or unique name or symbol from list_market_segments.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["at","company_country","company_name","name","sector_id","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_public_capital","short_public_shares","short_public_value","short_total_capital","short_total_shares","short_total_value","symbol"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["at","company_country","company_name","industry_id","market_segment_id","name","sector_id","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_public_capital","short_public_shares","short_public_value","short_total_capital","short_total_shares","short_total_value","symbol"],"type":"string"},"op":{"enum":["contains","eq","gt","gte","in","lt","lte","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"shorted_stocks":{"description":"Flat short-interest aggregates per security","items":{"additionalProperties":false,"properties":{"at":{"format":"date","type":"string"},"company_country":{"type":"string"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party; null when not indexed","type":["string","null"]},"industry_id":{"type":["integer","null"]},"industry_name":{"type":["string","null"]},"name":{"type":"string"},"sector_id":{"type":["integer","null"]},"sector_name":{"type":["string","null"]},"short_anonymous_capital":{"type":["number","null"]},"short_anonymous_currency":{"type":["string","null"]},"short_anonymous_shares":{"type":["integer","null"]},"short_anonymous_value":{"type":["number","null"]},"short_anonymous_verified_at":{"type":["string","null"]},"short_public_capital":{"type":["number","null"]},"short_public_currency":{"type":["string","null"]},"short_public_shares":{"type":["integer","null"]},"short_public_value":{"type":["number","null"]},"short_public_verified_at":{"type":["string","null"]},"short_total_capital":{"type":["number","null"]},"short_total_currency":{"type":["string","null"]},"short_total_shares":{"type":["integer","null"]},"short_total_value":{"type":["number","null"]},"short_total_verified_at":{"type":["string","null"]},"stock_id":{"description":"Present for security-level rows; absent for company aggregate history","type":["integer","null"]},"symbol":{"type":"string"}},"required":["company_party_id","company_name","company_country","industry_id","industry_name","sector_id","sector_name","at","short_total_capital","short_total_shares","short_total_value","short_total_currency","short_total_verified_at","short_public_capital","short_public_shares","short_public_value","short_public_currency","short_public_verified_at","short_anonymous_capital","short_anonymous_shares","short_anonymous_value","short_anonymous_currency","short_anonymous_verified_at"],"type":"object"},"type":"array"}},"required":["shorted_stocks","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List shorted stocks"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"List shorted stocks","tags":["market"]}},"/market/search_entities":{"post":{"description":"Resolve names, tickers or keywords to IDs. Each term is searched across companies, stocks, market parties (owners, issuers, short sellers, research firms), market segments, industries and sectors, and with the CRM scope also contacts, coworkers, targeting lists, event labels, organizers, locations and events. Returns ranked candidates per type with party_id, contact_id, stock_id or the catalog ID used by the other tools. Types that could not be searched are listed in unavailable.","operationId":"search_entities","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"limit":{"description":"Maximum hits per type and term, best first, 1-10. Default 5.","maximum":10,"minimum":1,"type":["integer","null"]},"only_underlying":{"description":"Party hits become only underlying holdings parties beneath a parent (funds, mandates, accounts), each with its parent_party_id; parents, autonomous owners and parties without holdings are excluded. Use for a specifically named fund or sub-fund. By default party search omits underlying parties. Other types are unaffected","type":["boolean","null"]},"terms":{"description":"Names, tickers or keywords to look up, one distinct mention per term, as written but without company suffixes (AB, PLC, Inc, Ltd, Group). Matching is word-prefix based, so a short distinctive term ('volvo', 'norges bank', 'large cap') beats a long one","items":{"type":"string"},"maxItems":8,"minItems":1,"type":"array"},"types":{"description":"Restrict the search to these types; omit to search all types available to the token. contact, coworker, targeting_list, label, organizer, location and event require the monitor:crm.read scope.","items":{"enum":["company","stock","party","contact","coworker","targeting_list","label","organizer","location","event","market_segment","industry","sector"],"type":"string"},"type":["array","null"]}},"required":["terms"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"results":{"description":"One entry per term, in request order","items":{"additionalProperties":false,"properties":{"companies":{"description":"Issuing companies matched by the company search, with canonical party_id","items":{"additionalProperties":false,"properties":{"country":{"description":"ISO-2 country of the market the company's primary instrument trades on","type":["string","null"]},"lei":{"type":["string","null"]},"name":{"type":"string"},"party_id":{"description":"Canonical party ID; null when the company is not indexed","type":["string","null"]},"score":{"type":"number"}},"required":["party_id","name","score"],"type":"object"},"type":"array"},"contacts":{"description":"One candidate per human, with CRM and coverage facets","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"Canonical contact ID shared by a person and linked analyst","type":"string"},"facets":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"ranking_score":{"type":"number"}},"required":["contact_id","name","facets","ranking_score"],"type":"object"},"type":"array"},"coworkers":{"description":"The customer's own team members (coworker_id)","items":{"additionalProperties":false,"properties":{"coworker_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"role":{"type":["string","null"]},"score":{"type":"number"}},"required":["coworker_id","name","score"],"type":"object"},"type":"array"},"events":{"description":"Customer events matched by title, notes, participants, organizer or location (event_id)","items":{"additionalProperties":false,"properties":{"event_id":{"format":"uuid","type":"string"},"location":{"type":["string","null"]},"organizer":{"type":["string","null"]},"score":{"type":"number"},"start_time":{"type":"string"},"title":{"type":["string","null"]}},"required":["event_id","start_time","score"],"type":"object"},"type":"array"},"industries":{"description":"Industries (industry_id)","items":{"additionalProperties":false,"properties":{"industry_id":{"type":"integer"},"name":{"type":"string"},"score":{"type":"number"}},"required":["industry_id","name","score"],"type":"object"},"type":"array"},"labels":{"description":"Event labels (label_id)","items":{"additionalProperties":false,"properties":{"label_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"score":{"type":"number"}},"required":["label_id","name","score"],"type":"object"},"type":"array"},"locations":{"description":"Exact location strings used on the customer's recent events; pass the value verbatim as a locations filter","items":{"additionalProperties":false,"properties":{"score":{"type":"number"},"value":{"description":"Exact string as stored on the events; use verbatim","type":"string"}},"required":["value","score"],"type":"object"},"type":"array"},"market_segments":{"description":"Market segments / lists such as Nasdaq Stockholm Large Cap (market_segment_id)","items":{"additionalProperties":false,"properties":{"country":{"type":"string"},"currency":{"type":"string"},"market_segment_id":{"type":"integer"},"name":{"type":"string"},"score":{"type":"number"},"symbol":{"type":"string"}},"required":["market_segment_id","name","symbol","country","currency","score"],"type":"object"},"type":"array"},"organizers":{"description":"Exact organizer strings used on the customer's recent events; pass the value verbatim as an organizers filter","items":{"additionalProperties":false,"properties":{"score":{"type":"number"},"value":{"description":"Exact string as stored on the events; use verbatim","type":"string"}},"required":["value","score"],"type":"object"},"type":"array"},"parties":{"description":"One candidate per party, with merged facets","items":{"additionalProperties":false,"properties":{"aum_sek":{"type":["number","null"]},"country":{"type":["string","null"]},"facets":{"items":{"type":"string"},"type":"array"},"is_sell_side":{"type":"boolean"},"mcap_sek":{"type":["number","null"]},"name":{"type":"string"},"parent_party_id":{"description":"Parent owner of an underlying party (fund, mandate, account); absent for roots and standalone parties","type":["string","null"]},"party_id":{"description":"Canonical party ID shared by all linked source records","type":"string"},"ranking_score":{"type":"number"},"type":{"type":["string","null"]}},"required":["party_id","name","facets","is_sell_side","ranking_score"],"type":"object"},"type":"array"},"sectors":{"description":"Sectors (sector_id)","items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"score":{"type":"number"},"sector_id":{"type":"integer"}},"required":["sector_id","name","score"],"type":"object"},"type":"array"},"stocks":{"description":"Share classes (stock_id) matched by name, ticker, ISIN or issuing company name; each carries its company_party_id","items":{"additionalProperties":false,"properties":{"company_name":{"type":["string","null"]},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"isin":{"type":["string","null"]},"market_segment":{"type":["string","null"]},"name":{"type":"string"},"score":{"type":"number"},"stock_id":{"type":"integer"},"symbol":{"type":["string","null"]}},"required":["stock_id","name","symbol","isin","company_party_id","company_name","market_segment","score"],"type":"object"},"type":"array"},"targeting_lists":{"description":"The customer's targeting lists (targeting_list_id)","items":{"additionalProperties":false,"properties":{"name":{"type":"string"},"score":{"type":"number"},"targeting_list_id":{"format":"uuid","type":"string"}},"required":["targeting_list_id","name","score"],"type":"object"},"type":"array"},"term":{"type":"string"}},"required":["term"],"type":"object"},"type":"array"},"unavailable":{"description":"Types that could not be searched in this call. Their absence from results says nothing about whether matches exist","items":{"additionalProperties":false,"properties":{"reason":{"description":"Why the type could not be searched, e.g. a timeout or an unavailable source.","type":"string"},"type":{"type":"string"}},"required":["type","reason"],"type":"object"},"type":"array"}},"required":["results"],"type":"object"}}},"description":"Search entities"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"Search entities","tags":["market"]}},"/market/search_stocks":{"post":{"description":"Find share classes (stocks) by name, ticker or ISIN, or list the stocks of given companies. Returns stock_id, symbol, ISIN, name and the issuing company. A text-only search returns at most 10 ranked candidates.","operationId":"search_stocks","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"Optional selection of 1–1000 canonical company party IDs","items":{"type":"string"},"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of stocks entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_name (string; eq, in, contains), isin (string; eq, in, contains), name (string; eq, ne, in, contains), stock_id (integer; eq, in), symbol (string; eq, in, contains). sort is a list of {field, desc} on: company_name, isin, name, stock_id, symbol. search is a text match on: company_name, isin, name, symbol.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["company_name","isin","name","stock_id","symbol"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_name","isin","name","stock_id","symbol"],"type":"string"},"op":{"enum":["contains","eq","in","ne"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"stock_ids":{"items":{"type":"integer"},"type":["array","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"stocks":{"items":{"additionalProperties":false,"properties":{"company_name":{"type":["string","null"]},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"isin":{"type":["string","null"]},"market_segment":{"type":["string","null"]},"name":{"type":"string"},"stock_id":{"type":"integer"},"symbol":{"type":["string","null"]}},"required":["stock_id","name","symbol","isin","company_party_id","company_name","market_segment"],"type":"object"},"type":"array"}},"required":["stocks","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Search stocks"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:market.read"]}],"summary":"Search stocks","tags":["market"]}},"/ownership/get_company_aggregates":{"post":{"description":"Ownership summary per company: number of owners and the capital, votes and owner count of foreign owners, funds, active funds, passive funds and ESG funds, each with its latest contributing date. Capital and votes are fractions (0-1).","operationId":"get_company_aggregates","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"format":"date","type":["string","null"]},"company_party_ids":{"description":"Select 1–1000 canonical company party IDs","items":{"type":"string"},"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of aggregates entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: active_fund_at (date; eq, gte, lte), active_fund_capital (number; eq, gte, lte), active_fund_owners (integer; eq, gte, lte), active_fund_votes (number; eq, gte, lte), company_name (string; eq, in, contains), esg_fund_at (date; eq, gte, lte), esg_fund_capital (number; eq, gte, lte), esg_fund_owners (integer; eq, gte, lte), esg_fund_votes (number; eq, gte, lte), foreign_at (date; eq, gte, lte), foreign_capital (number; eq, gte, lte), foreign_owners (integer; eq, gte, lte), foreign_votes (number; eq, gte, lte), fund_at (date; eq, gte, lte), fund_capital (number; eq, gte, lte), fund_owners (integer; eq, gte, lte), fund_votes (number; eq, gte, lte), number_of_owners (integer; eq, gte, lte), number_of_owners_date (date; eq, gte, lte), passive_fund_at (date; eq, gte, lte), passive_fund_capital (number; eq, gte, lte), passive_fund_owners (integer; eq, gte, lte), passive_fund_votes (number; eq, gte, lte). sort is a list of {field, desc} on: active_fund_at, active_fund_capital, active_fund_owners, active_fund_votes, company_name, esg_fund_at, esg_fund_capital, esg_fund_owners, esg_fund_votes, foreign_at, foreign_capital, foreign_owners, foreign_votes, fund_at, fund_capital, fund_owners, fund_votes, number_of_owners, number_of_owners_date, passive_fund_at, passive_fund_capital, passive_fund_owners, passive_fund_votes. search is a text match on: company_name.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["active_fund_at","active_fund_capital","active_fund_owners","active_fund_votes","company_name","esg_fund_at","esg_fund_capital","esg_fund_owners","esg_fund_votes","foreign_at","foreign_capital","foreign_owners","foreign_votes","fund_at","fund_capital","fund_owners","fund_votes","number_of_owners","number_of_owners_date","passive_fund_at","passive_fund_capital","passive_fund_owners","passive_fund_votes"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["active_fund_at","active_fund_capital","active_fund_owners","active_fund_votes","company_name","esg_fund_at","esg_fund_capital","esg_fund_owners","esg_fund_votes","foreign_at","foreign_capital","foreign_owners","foreign_votes","fund_at","fund_capital","fund_owners","fund_votes","number_of_owners","number_of_owners_date","passive_fund_at","passive_fund_capital","passive_fund_owners","passive_fund_votes"],"type":"string"},"op":{"enum":["contains","eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"aggregates":{"items":{"additionalProperties":false,"properties":{"active_fund_at":{"type":["string","null"]},"active_fund_capital":{"type":["number","null"]},"active_fund_owners":{"type":["integer","null"]},"active_fund_votes":{"type":["number","null"]},"company_name":{"type":"string"},"company_party_id":{"description":"Canonical issuer party ID; null when unavailable","type":["string","null"]},"esg_fund_at":{"type":["string","null"]},"esg_fund_capital":{"type":["number","null"]},"esg_fund_owners":{"type":["integer","null"]},"esg_fund_votes":{"type":["number","null"]},"foreign_at":{"type":["string","null"]},"foreign_capital":{"type":["number","null"]},"foreign_owners":{"type":["integer","null"]},"foreign_votes":{"type":["number","null"]},"fund_at":{"type":["string","null"]},"fund_capital":{"type":["number","null"]},"fund_owners":{"type":["integer","null"]},"fund_votes":{"type":["number","null"]},"number_of_owners":{"type":["integer","null"]},"number_of_owners_date":{"type":["string","null"]},"passive_fund_at":{"type":["string","null"]},"passive_fund_capital":{"type":["number","null"]},"passive_fund_owners":{"type":["integer","null"]},"passive_fund_votes":{"type":["number","null"]}},"required":["company_party_id","company_name","number_of_owners","number_of_owners_date","foreign_capital","foreign_votes","foreign_owners","foreign_at","fund_capital","fund_votes","fund_owners","fund_at","active_fund_capital","active_fund_votes","active_fund_owners","active_fund_at","passive_fund_capital","passive_fund_votes","passive_fund_owners","passive_fund_at","esg_fund_capital","esg_fund_votes","esg_fund_owners","esg_fund_at"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]}},"required":["aggregates","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get company ownership aggregates"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Get company ownership aggregates","tags":["ownership"]}},"/ownership/get_holdings":{"post":{"description":"Shareholdings at a date (default today). A company ID alone returns the company's shareholder register; an owner ID or portfolio alone returns the owner's positions; both return that owner's position in that company. One ID per side per call and at most 2500 rows per ID. Rows have owner and company, owner type and country, shares, capital and votes as fractions (0-1), value, and the change since the previous quarter. Check status before treating a missing row as absence.","operationId":"get_holdings","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"description":"Holding date; defaults to today","format":"date","type":["string","null"]},"company_party_ids":{"description":"One issuer whose shareholders are wanted. Alone: every shareholder of the company. With an owner: only that owner's position in it","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of holdings entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"management_types":{"description":"Include only holdings managed using these approaches: Active, Passive or Quantitative. Matching fund holdings are combined into each owner and company total. Requires company_party_ids. Omit for unfiltered holdings","items":{"enum":["Active","Passive","Quantitative"],"type":"string"},"type":["array","null"]},"owner_party_ids":{"description":"One owner whose portfolio is wanted. Alone: every position of the owner. With a company: only its position in that company. Cannot be combined with portfolios","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"portfolios":{"description":"One parent plus optional underlying owner pair from a targeting selection; parent only is that owner's own portfolio. Cannot be combined with owner_party_ids","items":{"additionalProperties":false,"properties":{"owner_party_id":{"description":"Underlying owner party ID; omit or null for the parent portfolio","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio party ID","type":"string"}},"required":["parent_party_id"],"type":"object"},"maxItems":1,"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: company_domicile_country (string; eq, in), company_market_country (string; eq, in), industry_id (integer; eq, in), market_segment_id (integer; eq, in), owner_country (string; eq, in), owner_type (string; eq, in). sort is a list of {field, desc} on: capital, shares, value, votes. search is a text match on: company_name, owner_name. company_domicile_country, company_market_country, owner_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions. industry_id, market_segment_id: numeric ID or unique catalog name (market segments also accept symbols). owner_type: owner type name from list_owner_types, e.g. Hedge Fund, Family Office or Pension Fund.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["capital","shares","value","votes"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["company_domicile_country","company_market_country","industry_id","market_segment_id","owner_country","owner_type"],"type":"string"},"op":{"enum":["eq","in"],"type":"string"},"value":{"description":"eq takes one value of the field's type; in takes a nonempty array of that type. company_domicile_country: string (eq,in). company_market_country: string (eq,in). industry_id: integer (eq,in). market_segment_id: integer (eq,in). owner_country: string (eq,in). owner_type: string (eq,in). owner_type accepts English names from list_owner_types (for example Hedge Fund, Family Office, Pension Fund); legacy owner-label categories are not accepted. Industry and market-segment filters accept numeric IDs or unique catalog names; market segments also accept unique symbols."}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"at":{"type":"string"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"holdings":{"items":{"additionalProperties":false,"properties":{"capital":{"description":"Fraction of company capital (0–1)","type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null only for a position in a company that is not indexed","type":["string","null"]},"currency":{"type":"string"},"delta_capital":{"description":"Signed capital fraction change (0–1 units); null when unavailable","type":["number","null"]},"delta_date":{"description":"Previous holding observation used for the last-quarter change; null when unavailable","type":["string","null"]},"delta_shares":{"type":["integer","null"]},"delta_votes":{"description":"Signed vote fraction change (0–1 units); null when unavailable","type":["number","null"]},"owner_country":{"description":"Owner domicile, ISO 3166-1 alpha-2; null when unknown","type":["string","null"]},"owner_name":{"type":"string"},"owner_party_id":{"description":"Shareholder party ID","type":"string"},"owner_type":{"type":"string"},"parent_party_id":{"description":"Underlying relationship parent; null for aggregates and autonomous owners","type":["string","null"]},"shares":{"type":"integer"},"valid_from":{"description":"Observation date of this holding","type":"string"},"value":{"description":"Position value in currency","type":"number"},"votes":{"description":"Fraction of company votes (0–1)","type":"number"}},"required":["company_party_id","company_name","owner_party_id","owner_name","owner_type","owner_country","parent_party_id","shares","capital","votes","value","currency","valid_from","delta_date","delta_shares","delta_capital","delta_votes"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"description":"Retrieval per requested ID; with both a company and an owner or portfolio the single row names both sides. state partial or unavailable means not every row of the ID could be retrieved; check it before treating a missing row as absence.","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Requested issuer this row describes; on owner rows the single requested issuer the positions were filtered to, otherwise null","type":["string","null"]},"owner_party_id":{"description":"Requested owner this row describes; on company rows the single requested owner the shareholders were filtered to, otherwise null","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio when the owner was requested as an underlying pair; null otherwise","type":["string","null"]},"reason":{"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["company_party_id","owner_party_id","parent_party_id","state"],"type":"object"},"type":"array"}},"required":["at","holdings","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get holdings"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Get holdings","tags":["ownership"]}},"/ownership/get_owner_profiles":{"post":{"description":"Owner profiles by party ID: name, type, domicile, parent owner, number of sub-owners and assets under management with date and currency (reported AUM, else the sum of known sub-owner AUM, else equity value).","operationId":"get_owner_profiles","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of party_ids fetched per call, 1-500, default 50. The remaining IDs are fetched with next_cursor.","maximum":500,"minimum":1,"type":["integer","null"]},"party_ids":{"description":"Party IDs with owner profiles; one id is fine","items":{"type":"string"},"maxItems":2500,"minItems":1,"type":"array"}},"required":["party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"owners":{"items":{"additionalProperties":false,"properties":{"aum":{"additionalProperties":false,"description":"Assets under management (AUM); absent when unknown","properties":{"at":{"description":"Date the AUM figure refers to, YYYY-MM-DD","format":"date","type":"string"},"value":{"additionalProperties":false,"description":"AUM in the user's currency","properties":{"amount":{"description":"Monetary value of the equity holding, in the specified currency","type":"number"},"currency":{"description":"Currency code of the equity holding value, e.g. 'USD', 'EUR'","type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["at","value"],"type":["object","null"]},"country":{"description":"Domicile of the owner, ISO 3166-1 alpha-2","type":["string","null"]},"name":{"type":"string"},"num_children":{"description":"Number of sub-owners (e.g. funds) under this owner","type":["integer","null"]},"parent":{"additionalProperties":false,"description":"Parent owner, if this is a sub-owner (e.g. a fund under a fund company)","properties":{"name":{"type":"string"},"party_id":{"description":"Canonical party ID of this trade owner","type":["string","null"]}},"required":["party_id","name"],"type":["object","null"]},"party_id":{"description":"Canonical party ID of this trade owner","type":["string","null"]},"type":{"additionalProperties":false,"properties":{"en":{"type":"string"}},"required":["en"],"type":"object"}},"required":["party_id","name","country","type"],"type":"object"},"type":"array"}},"required":["owners","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Get owner profiles"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Get owner profiles","tags":["ownership"]}},"/ownership/get_ownership_by_country":{"post":{"description":"Ownership of one company split by owner country, one row per date and country with capital and votes as fractions (0-1), shares and number of owners. All available dates are returned, newest first; filter on as_of_date for specific dates.","operationId":"get_ownership_by_country","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"One company party ID with an issuer record.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"latest":{"description":"true returns only each company's most recent snapshot within the as_of_date span, with all of its bucket rows: alone it is the current distribution, with as_of_date lte D it is the snapshot as of D whatever its exact date. Omit or false for every snapshot in the span. Do not add query.limit to get the latest snapshot; a limit cuts its buckets","type":"boolean"},"limit":{"default":50,"description":"Page size: maximum number of distribution entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: as_of_date (date; eq, in, gte, lte), country (string; eq, in). sort is a list of {field, desc} on: as_of_date, capital, country, owners, shares, votes. country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["as_of_date","capital","country","owners","shares","votes"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["as_of_date","country"],"type":"string"},"op":{"enum":["eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"distribution":{"items":{"additionalProperties":false,"properties":{"as_of_date":{"description":"Distribution date, YYYY-MM-DD","type":"string"},"capital":{"type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Requested company party ID","type":"string"},"country":{"description":"Country of the group, ISO 3166-1 alpha-2 format","type":"string"},"is_foreign":{"description":"is considered a foreign country, given the company","type":"boolean"},"owners":{"type":"integer"},"shares":{"type":"integer"},"votes":{"type":"number"}},"required":["is_foreign","company_party_id","company_name","as_of_date","country","owners","shares","capital","votes"],"type":"object"},"type":"array"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"description":"Retrieval status of the requested company. state partial or unavailable means not every row could be retrieved.","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Requested issuer this row describes; on owner rows the single requested issuer the positions were filtered to, otherwise null","type":["string","null"]},"owner_party_id":{"description":"Requested owner this row describes; on company rows the single requested owner the shareholders were filtered to, otherwise null","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio when the owner was requested as an underlying pair; null otherwise","type":["string","null"]},"reason":{"type":"string"},"rows":{"description":"Rows retrieved for this id","type":"integer"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["company_party_id","owner_party_id","parent_party_id","state","rows"],"type":"object"},"type":"array"}},"required":["coverage","dropped_ids","distribution","status","next_cursor"],"type":"object"}}},"description":"Get ownership by country"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Get ownership by country","tags":["ownership"]}},"/ownership/get_ownership_by_owner_type":{"post":{"description":"Ownership of one company split by owner type, one row per date and owner type with capital and votes as fractions (0-1), shares and number of owners. All available dates are returned, newest first; filter on as_of_date for specific dates.","operationId":"get_ownership_by_owner_type","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"One company party ID with an issuer record.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"latest":{"description":"true returns only each company's most recent snapshot within the as_of_date span, with all of its bucket rows: alone it is the current distribution, with as_of_date lte D it is the snapshot as of D whatever its exact date. Omit or false for every snapshot in the span. Do not add query.limit to get the latest snapshot; a limit cuts its buckets","type":"boolean"},"limit":{"default":50,"description":"Page size: maximum number of distribution entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: as_of_date (date; eq, in, gte, lte), owner_type (string; eq, in). sort is a list of {field, desc} on: as_of_date, capital, owner_type, owners, shares, votes. owner_type: owner type name from list_owner_types; Unknown owner type selects owners without a type.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["as_of_date","capital","owner_type","owners","shares","votes"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["as_of_date","owner_type"],"type":"string"},"op":{"enum":["eq","gte","in","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]}},"required":["company_party_ids"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"distribution":{"items":{"additionalProperties":false,"properties":{"as_of_date":{"description":"Distribution date, YYYY-MM-DD","type":"string"},"capital":{"type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Requested company party ID","type":"string"},"owner_type":{"description":"Owner type of the group","type":"string"},"owners":{"description":"Number of owners in the aggregated group","type":"integer"},"shares":{"type":"integer"},"votes":{"type":"number"}},"required":["company_party_id","company_name","as_of_date","owner_type","owners","shares","capital","votes"],"type":"object"},"type":"array"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"description":"Retrieval status of the requested company. state partial or unavailable means not every row could be retrieved.","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Requested issuer this row describes; on owner rows the single requested issuer the positions were filtered to, otherwise null","type":["string","null"]},"owner_party_id":{"description":"Requested owner this row describes; on company rows the single requested owner the shareholders were filtered to, otherwise null","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio when the owner was requested as an underlying pair; null otherwise","type":["string","null"]},"reason":{"type":"string"},"rows":{"description":"Rows retrieved for this id","type":"integer"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["company_party_id","owner_party_id","parent_party_id","state","rows"],"type":"object"},"type":"array"}},"required":["coverage","dropped_ids","distribution","status","next_cursor"],"type":"object"}}},"description":"Get ownership by owner type"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Get ownership by owner type","tags":["ownership"]}},"/ownership/list_holding_changes":{"post":{"description":"Net position changes between from and to (inclusive) for a company, an owner or both: the buyers and sellers in a company, or an owner's changes across its portfolio. One row per owner and company that changed, with the position after the change and signed changes in shares, capital, votes and value. change_type NEW selects opened positions and SOLD_ALL fully exited ones. Sorting on shares, capital, votes or value orders by the change, not by the position after it. One ID per side per call and at most 2500 rows per ID.","operationId":"list_holding_changes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"One issuer whose shareholder changes are wanted. Alone: every owner's change in the company. With an owner: only that owner's changes in it","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"First day of the change window, inclusive","format":"date","type":"string"},"limit":{"default":50,"description":"Page size: maximum number of deltas entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"management_types":{"description":"Include only holdings managed using these approaches: Active, Passive or Quantitative. Matching fund holdings are combined into each owner and company total. Requires company_party_ids. Omit for unfiltered holdings","items":{"enum":["Active","Passive","Quantitative"],"type":"string"},"type":["array","null"]},"owner_party_ids":{"description":"One owner whose position changes are wanted. Alone: every change across the owner's portfolio. With a company: only its changes in that company. Cannot be combined with portfolios","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"portfolios":{"description":"One parent plus optional underlying owner pair from a targeting selection; parent only selects the manager portfolio. Cannot be combined with owner_party_ids","items":{"additionalProperties":false,"properties":{"owner_party_id":{"description":"Underlying owner party ID; omit or null for the parent portfolio","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio party ID","type":"string"}},"required":["parent_party_id"],"type":"object"},"maxItems":1,"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: change_type (string; eq), company_domicile_country (string; eq, in), company_market_country (string; eq, in), industry_id (integer; eq, in), market_segment_id (integer; eq, in), owner_country (string; eq, in), owner_type (string; eq, in). sort is a list of {field, desc} on: capital, shares, votes. search is a text match on: company_name, owner_name. company_domicile_country, company_market_country, owner_country: ISO 3166-1 alpha-2 code or English country name; corrections are reported in filter_corrections and unknown values are rejected with suggestions. industry_id, market_segment_id: numeric ID or unique catalog name (market segments also accept symbols). owner_type: owner type name from list_owner_types, e.g. Hedge Fund, Family Office or Pension Fund.","properties":{"search":{"type":"string"},"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["capital","shares","votes"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["change_type","company_domicile_country","company_market_country","industry_id","market_segment_id","owner_country","owner_type"],"type":"string"},"op":{"enum":["eq","in"],"type":"string"},"value":{"description":"eq takes one value of the field's type; in takes a nonempty array of that type. change_type: string (eq). company_domicile_country: string (eq,in). company_market_country: string (eq,in). industry_id: integer (eq,in). market_segment_id: integer (eq,in). owner_country: string (eq,in). owner_type: string (eq,in). owner_type accepts English names from list_owner_types (for example Hedge Fund, Family Office, Pension Fund); legacy owner-label categories are not accepted. Industry and market-segment filters accept numeric IDs or unique catalog names; market segments also accept unique symbols."}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Last day of the change window, inclusive; defaults to today","format":"date","type":["string","null"]}},"required":["from"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"deltas":{"items":{"additionalProperties":false,"properties":{"capital":{"description":"Capital fraction (0–1) after the change","type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null only for a company that is not indexed","type":["string","null"]},"delta_capital":{"description":"Signed change in capital fraction (0–1 units)","type":"number"},"delta_currency":{"type":"string"},"delta_shares":{"description":"Signed change in shares over the window","type":"integer"},"delta_value":{"description":"Signed change in value, in delta_currency","type":"number"},"delta_votes":{"description":"Signed change in vote fraction (0–1 units)","type":"number"},"owner_country":{"description":"Owner domicile, ISO 3166-1 alpha-2; null when unknown","type":["string","null"]},"owner_name":{"type":"string"},"owner_party_id":{"description":"Shareholder party ID","type":"string"},"owner_type":{"type":"string"},"parent_party_id":{"description":"Underlying relationship parent; null for aggregates and autonomous owners","type":["string","null"]},"shares":{"description":"Shares held after the change","type":"integer"},"valid_from":{"description":"Date the position after the change became valid","type":"string"},"votes":{"description":"Vote fraction (0–1) after the change","type":"number"}},"required":["company_party_id","company_name","owner_party_id","owner_name","owner_type","owner_country","parent_party_id","shares","capital","votes","valid_from","delta_shares","delta_capital","delta_votes","delta_value","delta_currency"],"type":"object"},"type":"array"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"from":{"type":"string"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"description":"Retrieval per requested ID; with both a company and an owner or portfolio the single row names both sides. state partial or unavailable means not every row of the ID could be retrieved; check it before treating a missing row as absence.","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Requested issuer this row describes; on owner rows the single requested issuer the positions were filtered to, otherwise null","type":["string","null"]},"owner_party_id":{"description":"Requested owner this row describes; on company rows the single requested owner the shareholders were filtered to, otherwise null","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio when the owner was requested as an underlying pair; null otherwise","type":["string","null"]},"reason":{"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["company_party_id","owner_party_id","parent_party_id","state"],"type":"object"},"type":"array"},"to":{"type":"string"}},"required":["from","to","deltas","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List holding changes"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"List holding changes","tags":["ownership"]}},"/ownership/list_holding_transactions":{"post":{"description":"Recorded changes in shareholder registers, newest first, for a company, an owner or both. These are register observations, not market trades. Each row has the holding after the change and signed changes in shares, capital, votes and value; null changes mean unavailable, not zero. Omit from and to for the full recorded history. One ID per side per call and at most 10000 rows per ID.","operationId":"list_holding_transactions","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company_party_ids":{"description":"One issuer whose recorded ownership changes are wanted. Alone: every owner's changes in the company. With an owner: only that owner's changes in it","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"from":{"description":"Earliest valid_from, inclusive; omit for the full recorded history","format":"date","type":["string","null"]},"limit":{"default":50,"description":"Page size: maximum number of transactions entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"owner_party_ids":{"description":"One owner whose recorded changes are wanted. Alone: every change across the owner's history. With a company: only its changes in that company. Cannot be combined with portfolios","items":{"type":"string"},"maxItems":1,"type":["array","null"]},"portfolios":{"description":"One parent plus optional underlying owner pair from a targeting selection; parent only selects the manager portfolio. Cannot be combined with owner_party_ids","items":{"additionalProperties":false,"properties":{"owner_party_id":{"description":"Underlying owner party ID; omit or null for the parent portfolio","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio party ID","type":"string"}},"required":["parent_party_id"],"type":"object"},"maxItems":1,"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: owner_type (string; eq, in). sort is a list of {field, desc} on: valid_from. owner_type: owner type name from list_owner_types, e.g. Hedge Fund, Family Office or Pension Fund.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["valid_from"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["owner_type"],"type":"string"},"op":{"enum":["eq","in"],"type":"string"},"value":{"description":"eq takes one value of the field's type; in takes a nonempty array of that type. owner_type: string (eq,in). owner_type accepts English names from list_owner_types (for example Hedge Fund, Family Office, Pension Fund); legacy owner-label categories are not accepted. Industry and market-segment filters accept numeric IDs or unique catalog names; market segments also accept unique symbols."}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"to":{"description":"Latest valid_from, inclusive; omit for today","format":"date","type":["string","null"]}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"status":{"description":"Retrieval per requested ID; with both a company and an owner or portfolio the single row names both sides. state partial or unavailable means not every row of the ID could be retrieved; check it before treating a missing row as absence.","items":{"additionalProperties":false,"properties":{"company_party_id":{"description":"Requested issuer this row describes; on owner rows the single requested issuer the positions were filtered to, otherwise null","type":["string","null"]},"owner_party_id":{"description":"Requested owner this row describes; on company rows the single requested owner the shareholders were filtered to, otherwise null","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio when the owner was requested as an underlying pair; null otherwise","type":["string","null"]},"reason":{"type":"string"},"state":{"enum":["complete","partial","unavailable"],"type":"string"}},"required":["company_party_id","owner_party_id","parent_party_id","state"],"type":"object"},"type":"array"},"transactions":{"items":{"additionalProperties":false,"properties":{"capital":{"description":"Capital fraction (0–1) after the change","type":"number"},"company_name":{"type":"string"},"company_party_id":{"description":"Issuer party ID; null only for a company that is not indexed","type":["string","null"]},"delta_capital":{"description":"Signed change in capital fraction; null when unavailable","type":["number","null"]},"delta_currency":{"description":"Currency of delta_value; null when unavailable","type":["string","null"]},"delta_shares":{"description":"Signed change in shares; null when unavailable","type":["integer","null"]},"delta_value":{"description":"Signed change in value; null when unavailable","type":["number","null"]},"delta_votes":{"description":"Signed change in vote fraction; null when unavailable","type":["number","null"]},"owner_country":{"description":"Owner domicile, ISO 3166-1 alpha-2; null when unknown","type":["string","null"]},"owner_name":{"type":"string"},"owner_party_id":{"description":"Shareholder party ID","type":"string"},"owner_type":{"type":"string"},"parent_party_id":{"description":"Underlying relationship parent; null for aggregates and autonomous owners","type":["string","null"]},"shares":{"description":"Shares held after the change","type":"integer"},"valid_from":{"description":"Date the holding after the change became valid","type":"string"},"votes":{"description":"Vote fraction (0–1) after the change","type":"number"}},"required":["company_party_id","company_name","owner_party_id","owner_name","owner_type","owner_country","parent_party_id","valid_from","shares","capital","votes","delta_shares","delta_capital","delta_votes","delta_value","delta_currency"],"type":"object"},"type":"array"}},"required":["transactions","status","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"List holding transactions"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"List holding transactions","tags":["ownership"]}},"/ownership/list_owner_types":{"post":{"description":"List the owner type classifications (e.g. Hedge Fund, Family Office, Pension Fund) accepted by owner_type filters in get_holdings, list_holding_changes and list_holding_transactions.","operationId":"list_owner_types","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"accepted_names":{"description":"Semicolon-separated list of every accepted owner type name.","type":"string"},"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"owner_types":{"items":{"additionalProperties":false,"properties":{"owner_type":{"description":"Exact English name to use as query.where owner_type value on holdings, deltas or transactions","type":"string"},"owner_type_id":{"description":"Backend catalog ID for reference; equity query.where owner_type accepts the English name, not this ID","type":"integer"}},"required":["owner_type","owner_type_id"],"type":"object"},"type":"array"}},"required":["accepted_names","owner_types","coverage","dropped_ids"],"type":"object"}}},"description":"List owner types"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"List owner types","tags":["ownership"]}},"/ownership/search_owners":{"post":{"description":"Search owners (institutions, funds, asset managers, individuals) by name and get their party_id. Matches top-level owners whose name contains every search word as a word prefix; at most 10 owners, largest portfolio first, each with matching sub-owners and latest reported assets under management.","operationId":"search_owners","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"search":{"description":"Owner name as whole words or word prefixes (e.g. 'norges bank', 'blackr'). Separate alternatives with +","type":"string"}},"required":["search"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"owners":{"description":"List of owners matching the search term","items":{"additionalProperties":false,"properties":{"aum":{"additionalProperties":false,"description":"Latest reported assets under management (AUM); absent when unknown","properties":{"at":{"description":"Date the AUM figure refers to, YYYY-MM-DD","format":"date","type":"string"},"value":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000000 = 50bn), not millions","type":"number"},"currency":{"description":"Currency the owner reports its AUM in, e.g. 'USD', 'SEK'; not converted to the user's currency","type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["at","value"],"type":["object","null"]},"children":{"description":"List of child owners matching the filter, if any","items":{"additionalProperties":false,"properties":{"aum":{"additionalProperties":false,"description":"Latest reported assets under management (AUM); absent when unknown","properties":{"at":{"description":"Date the AUM figure refers to, YYYY-MM-DD","format":"date","type":"string"},"value":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000000 = 50bn), not millions","type":"number"},"currency":{"description":"Currency the owner reports its AUM in, e.g. 'USD', 'SEK'; not converted to the user's currency","type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["at","value"],"type":["object","null"]},"name":{"type":"string"},"party_id":{"description":"Canonical party ID of this trade owner","type":["string","null"]}},"required":["party_id","name"],"type":"object"},"type":"array"},"name":{"type":"string"},"party_id":{"description":"Canonical party ID of this trade owner","type":["string","null"]}},"required":["party_id","name","children"],"type":"object"},"type":"array"}},"required":["owners","coverage","dropped_ids"],"type":"object"}}},"description":"Search owners"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:ownership.read"]}],"summary":"Search owners","tags":["ownership"]}},"/targeting/screen_investors":{"post":{"description":"Screen investor portfolios for targeting. Selects parent portfolios, or underlying owner and parent pairs with underlying=true, filtered by owner type, domicile, portfolio size and composition, holdings in given stocks, CRM meeting status and manager location. Sort by fit score with query.sort [{field: owner_score, desc: true}]; scores range 0-10. Pass the returned pairs to get_holdings portfolios for positions.","operationId":"screen_investors","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"cursor":{"description":"Opaque next_cursor from the previous page. Keep every other argument unchanged when paging.","type":["string","null"]},"has_met_filter":{"description":"Parent CRM status: Met means any recorded customer event, including scheduled ones; Not met means none recorded. No date window","enum":["Met","Not met",null],"type":["string","null"]},"known_portfolio_value":{"additionalProperties":false,"description":"Known equity portfolio value; not reported total AUM","properties":{"max":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]},"min":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]}},"type":["object","null"]},"largest_position_share":{"additionalProperties":false,"description":"Largest position as a fraction of portfolio value (0–1)","properties":{"max":{"type":["number","null"]},"min":{"type":["number","null"]}},"type":["object","null"]},"limit":{"default":50,"description":"Page size: maximum number of selections entries, 1-500, default 50.","maximum":500,"minimum":1,"type":["integer","null"]},"management_styles":{"description":"Underlying only: investment styles","items":{"enum":["Activist","Alternative","Growth","Hedge","Multi-style","No style","Quality","Special situations","Style neutral","Thematic","Value"],"type":"string"},"type":["array","null"]},"management_types":{"description":"Underlying only; omit for all management types","items":{"enum":["Active","Passive","Unknown"],"type":"string"},"type":["array","null"]},"manager_filter":{"additionalProperties":false,"properties":{"cities":{"description":"Cities where the owner's contact persons are located, exact names, e.g. ['New York', 'London']","items":{"type":"string"},"type":["array","null"]},"countries":{"description":"Countries where the owner's contact persons are located, ISO alpha-2, e.g. ['US', 'GB']","items":{"type":"string"},"type":["array","null"]}},"type":["object","null"]},"median_position_size":{"additionalProperties":false,"description":"Portfolio median position value, not AUM","properties":{"max":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]},"min":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]}},"type":["object","null"]},"number_positions":{"additionalProperties":false,"properties":{"max":{"type":["integer","null"]},"min":{"type":["integer","null"]}},"type":["object","null"]},"number_underlying_portfolios":{"additionalProperties":false,"description":"Parent only: number of underlying portfolios","properties":{"max":{"type":["integer","null"]},"min":{"type":["integer","null"]}},"type":["object","null"]},"owner_domicile":{"description":"Domicile at the selected level: parent or underlying owner; ISO alpha-2","items":{"type":"string"},"type":["array","null"]},"owner_party_ids":{"description":"Restrict underlying owners; requires underlying=true","items":{"type":"string"},"type":["array","null"]},"owner_types":{"description":"Parent owner classifications; ESG instead selects underlying ESG owners","items":{"enum":["Institutional","Private individual","Fund company","Pension \u0026 insurance","Investment \u0026 private equity","Government","Foundation","Hedge fund","ESG","Other"],"type":"string"},"type":["array","null"]},"owns_companies_with_market_cap":{"additionalProperties":false,"description":"Has a holding in an issuer of this market cap; not investor AUM","properties":{"max":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]},"min":{"additionalProperties":false,"properties":{"amount":{"description":"Amount in full currency units (e.g. 50000000 = 50M), not millions","type":"number"},"currency":{"description":"Currency code, e.g. 'USD', 'EUR'","maxLength":3,"minLength":3,"type":"string"}},"required":["amount","currency"],"type":["object","null"]}},"type":["object","null"]},"parent_party_ids":{"description":"Restrict eligible parent parties; intersects CRM filters","items":{"type":"string"},"type":["array","null"]},"portfolio_general_companies_filter":{"additionalProperties":false,"description":"Market country, sector, industry and segment are ANDed on matching positions; values within each list are alternatives","properties":{"in_countries":{"description":"Keep portfolios holding at least one company listed in these countries; ISO alpha-2 codes or recognized English names","items":{"type":"string"},"type":["array","null"]},"in_industries":{"description":"Keep portfolios holding at least one company in these industries: numeric catalog IDs or unique names; no quoted numbers","items":{},"type":["array","null"]},"in_market_segment":{"description":"Keep portfolios holding at least one company listed in these market segments: numeric catalog IDs or unique names/symbols; no quoted numbers","items":{},"type":["array","null"]},"in_sectors":{"description":"Sectors of held companies: numeric catalog IDs or unique names; no quoted numbers","items":{},"type":["array","null"]}},"type":["object","null"]},"portfolio_stock_filters":{"additionalProperties":false,"description":"Current/historical stock conditions at the selected portfolio level; filter categories are ANDed","properties":{"has_owned_stock_ids":{"additionalProperties":false,"description":"Has owned at any time, including current holders","properties":{"operator":{"description":"AND = satisfy this condition for every stock_id; OR = for at least one. For negative conditions, OR permits holding some listed stocks; AND excludes all listed stocks","enum":["AND","OR"],"type":"string"},"stock_ids":{"description":"stock_id values (not party_id); a company with several share classes has several stock_ids","items":{"type":"integer"},"type":"array"}},"required":["stock_ids","operator"],"type":["object","null"]},"not_has_owned_stock_ids":{"additionalProperties":false,"description":"Has never owned","properties":{"operator":{"description":"AND = satisfy this condition for every stock_id; OR = for at least one. For negative conditions, OR permits holding some listed stocks; AND excludes all listed stocks","enum":["AND","OR"],"type":"string"},"stock_ids":{"description":"stock_id values (not party_id); a company with several share classes has several stock_ids","items":{"type":"integer"},"type":"array"}},"required":["stock_ids","operator"],"type":["object","null"]},"not_owns_stock_ids":{"additionalProperties":false,"description":"Does not currently own (may have owned in the past)","properties":{"operator":{"description":"AND = satisfy this condition for every stock_id; OR = for at least one. For negative conditions, OR permits holding some listed stocks; AND excludes all listed stocks","enum":["AND","OR"],"type":"string"},"stock_ids":{"description":"stock_id values (not party_id); a company with several share classes has several stock_ids","items":{"type":"integer"},"type":"array"}},"required":["stock_ids","operator"],"type":["object","null"]},"owns_stock_ids":{"additionalProperties":false,"description":"Currently owns","properties":{"operator":{"description":"AND = satisfy this condition for every stock_id; OR = for at least one. For negative conditions, OR permits holding some listed stocks; AND excludes all listed stocks","enum":["AND","OR"],"type":"string"},"stock_ids":{"description":"stock_id values (not party_id); a company with several share classes has several stock_ids","items":{"type":"integer"},"type":"array"}},"required":["stock_ids","operator"],"type":["object","null"]}},"type":["object","null"]},"portfolios":{"description":"Restrict to these exact parent plus optional owner pairs, of the selected search level","items":{"additionalProperties":false,"properties":{"owner_party_id":{"description":"Underlying owner party ID; omit or null for the parent portfolio","type":["string","null"]},"parent_party_id":{"description":"Parent portfolio party ID","type":"string"}},"required":["parent_party_id"],"type":"object"},"type":["array","null"]},"query":{"additionalProperties":false,"description":"Optional row selection. where is an AND list of {field, op, value} predicates; the value of an 'in' predicate is a non-empty array of alternatives. Filter fields: owner_score (number; eq, gte, lte). sort is a list of {field, desc} on: owner_score.","properties":{"sort":{"items":{"additionalProperties":false,"properties":{"desc":{"type":"boolean"},"field":{"enum":["owner_score"],"type":"string"}},"required":["field"],"type":"object"},"type":"array"},"where":{"items":{"additionalProperties":false,"properties":{"field":{"enum":["owner_score"],"type":"string"},"op":{"enum":["eq","gte","lte"],"type":"string"},"value":{}},"required":["field","op","value"],"type":"object"},"type":"array"}},"type":["object","null"]},"underlying":{"description":"false (default): search parent portfolios; true: search underlying owner-parent portfolios. Portfolio filters apply at the selected level","type":"boolean"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"coverage":{"additionalProperties":false,"properties":{"backend_total":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"retrieval":{"additionalProperties":{},"type":"object"},"state":{"type":"string"}},"required":["state"],"type":"object"},"dropped_ids":{"type":"integer"},"filter_corrections":{"items":{"additionalProperties":false,"properties":{"applied":{},"field":{"type":"string"},"input":{}},"required":["field","input","applied"],"type":"object"},"type":"array"},"filter_warnings":{"items":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"},"code":{"type":"string"},"discovery_tool":{"type":"string"},"field":{"type":"string"},"input":{},"message":{"type":"string"},"operator":{"type":"string"},"suggestions":{"items":{"additionalProperties":false,"properties":{"label":{"type":"string"},"value":{}},"required":["value","label"],"type":"object"},"type":"array"}},"required":["code","field","input","message"],"type":"object"},"type":"array"},"next_cursor":{"description":"Cursor for the next page; pass it as cursor with otherwise unchanged arguments. Null on the last page.","type":["string","null"]},"selections":{"items":{"additionalProperties":false,"properties":{"latest_holding_date":{"type":"string"},"management_style":{"description":"Investment style, e.g. Growth or No style","type":["string","null"]},"management_type":{"description":"Active, Passive or Unknown","type":["string","null"]},"median_position_currency":{"type":["string","null"]},"median_position_value":{"type":["number","null"]},"owner_name":{"type":["string","null"]},"owner_party_id":{"description":"Canonical underlying owner party ID; null for parent portfolios","type":["string","null"]},"owner_score":{"description":"Monitor fit score 0–10; parent uses mean of top five available owner matches; null when unavailable","type":["number","null"]},"owner_score_date":{"type":["string","null"]},"parent_name":{"type":["string","null"]},"parent_party_id":{"description":"Canonical party ID of the parent portfolio","type":"string"}},"required":["parent_party_id","owner_party_id","parent_name","owner_name","owner_score","owner_score_date","latest_holding_date","median_position_value","median_position_currency","management_type","management_style"],"type":"object"},"type":"array"}},"required":["selections","coverage","dropped_ids","next_cursor"],"type":"object"}}},"description":"Screen investors"},"400":{"$ref":"#/components/responses/Problem400"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Problem403"},"404":{"$ref":"#/components/responses/Problem404"},"429":{"$ref":"#/components/responses/Problem429"},"500":{"$ref":"#/components/responses/Problem500"},"502":{"$ref":"#/components/responses/Problem502"}},"security":[{"oauth2":["monitor:targeting.read"]}],"summary":"Screen investors","tags":["targeting"]}}},"security":[{"oauth2":[]}],"servers":[{"url":"https://mcp.monitor.modularfinance.com/v1"}],"tags":[{"description":"Requires monitor:market.read","name":"market"},{"description":"Requires monitor:ownership.read","name":"ownership"},{"description":"Requires monitor:crm.read","name":"crm"},{"description":"Requires monitor:documents.read","name":"documents"},{"description":"Requires monitor:targeting.read","name":"targeting"},{"description":"Requires monitor:estimates.read","name":"estimates"},{"description":"Requires monitor:bonds.read","name":"bonds"}]}