OpenVibe.Trade API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://openvibe.trade. 19 routes performing 12 capabilities. OpenAPI 3.1 document.
GET /api/v1/alerts
Read the alert rules and recent deliveries of the person in X-OV-Subject.
- Capabilities
- trade.alert.read
- Visibility
- first-party
- Response
application/jsontrade.alert-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.alert.read</strong> (first-party): Read the alert rules and recent deliveries of the person in X-OV-Subject.</p>POST /api/v1/alerts
Create an alert rule for the person in X-OV-Subject: threshold (a crossing of a metric in a unit), filing_type or new_document.
- Capabilities
- trade.alert.create
- Visibility
- first-party
- Request body
application/jsontrade.alert-rule-request@1- Response
application/jsontrade.alert-rule-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.alert.create</strong> (first-party): Create an alert rule for the person in X-OV-Subject: threshold (a crossing of a metric in a unit), filing_type or new_document. Deliveries are unique per (rule, triggering observation or document) and are sent as trade.alert.triggered (visibility subject); no email.</p>DELETE /api/v1/alerts/{id}
Delete an alert rule of the person in X-OV-Subject.
- Capabilities
- trade.alert.delete
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsontrade.deleted-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.alert.delete</strong> (first-party): Delete an alert rule of the person in X-OV-Subject.</p>GET /api/v1/alerts/deliveries
Read the alert rules and recent deliveries of the person in X-OV-Subject.
- Capabilities
- trade.alert.read
- Visibility
- first-party
- Response
application/jsontrade.alert-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.alert.read</strong> (first-party): Read the alert rules and recent deliveries of the person in X-OV-Subject.</p>POST /api/v1/instruments
Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases.
- Capabilities
- trade.instrument.manage
- Visibility
- first-party
- Request body
application/jsontrade.instrument-manage-request@1- Response
application/jsontrade.instrument-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.instrument.manage</strong> (first-party): Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases. People must also be on the Trade editor list.</p>PATCH /api/v1/instruments/{symbol}
Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases.
- Capabilities
- trade.instrument.manage
- Visibility
- first-party
- Parameters
symbol(path, required)
- Request body
application/jsontrade.instrument-manage-request@1- Response
application/jsontrade.instrument-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.instrument.manage</strong> (first-party): Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases. People must also be on the Trade editor list.</p>POST /api/v1/instruments/{symbol}/aliases
Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases.
- Capabilities
- trade.instrument.manage
- Visibility
- first-party
- Parameters
symbol(path, required)
- Request body
application/jsontrade.instrument-manage-request@1- Response
application/jsontrade.instrument-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.instrument.manage</strong> (first-party): Create and edit instruments (symbol, name, kind, exchange, CIK, currency, status) and add ticker, CIK or name aliases. People must also be on the Trade editor list.</p>GET /api/v1/instruments/{symbol}/context
Read an instrument's published context with its citations and disclosure; with ?all=1 the drafts awaiting review; and the numbered-source input for OpenVibe.AI's trade.summarize_market_context workflo
- Capabilities
- trade.context.read
- Visibility
- first-party
- Parameters
symbol(path, required)
- Response
application/jsontrade.context-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.context.read</strong> (first-party): Read an instrument's published context with its citations and disclosure; with ?all=1 the drafts awaiting review; and the numbered-source input for OpenVibe.AI's trade.summarize_market_context workflow.</p>POST /api/v1/instruments/{symbol}/context
Deliver a context revision.
- Capabilities
- trade.context.propose
- Visibility
- first-party
- Parameters
symbol(path, required)
- Request body
application/jsontrade.context-proposal@1- Response
application/jsontrade.context-proposal-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.context.propose</strong> (first-party): Deliver a context revision. With X-OV-Origin: ai it is OpenVibe.AI output (workflow trade.summarize_market_context and its run id required): authorship ai, never attributed to a person, stored as a draft that cannot be published before a person on the editor list approves it. Text that reads as a recommendation to trade is refused.</p>GET /api/v1/instruments/{symbol}/context/input
Read an instrument's published context with its citations and disclosure; with ?all=1 the drafts awaiting review; and the numbered-source input for OpenVibe.AI's trade.summarize_market_context workflo
- Capabilities
- trade.context.read
- Visibility
- first-party
- Parameters
symbol(path, required)
- Response
application/jsontrade.context-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.context.read</strong> (first-party): Read an instrument's published context with its citations and disclosure; with ?all=1 the drafts awaiting review; and the numbered-source input for OpenVibe.AI's trade.summarize_market_context workflow.</p>GET /api/v1/instruments/resolve
Resolve a ticker, SEC CIK or exact company name to an instrument, deterministically (CIK, then ticker, then exact normalised name; several name matches are "ambiguous" and none is chosen).
- Capabilities
- trade.instrument.resolve
- Visibility
- first-party
- Response
application/jsontrade.resolve-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.instrument.resolve</strong> (first-party): Resolve a ticker, SEC CIK or exact company name to an instrument, deterministically (CIK, then ticker, then exact normalised name; several name matches are "ambiguous" and none is chosen). Browsers and anonymous readers need no capability.</p>POST /api/v1/observations
Record a market observation a source stated: value exactly as stated, unit, currency, observed_at (required, never inferred), source key and reference, retrieved_at (required).
- Capabilities
- trade.observation.write
- Visibility
- first-party
- Request body
application/jsontrade.observation-request@1- Response
application/jsontrade.observation-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.observation.write</strong> (first-party): Record a market observation a source stated: value exactly as stated, unit, currency, observed_at (required, never inferred), source key and reference, retrieved_at (required). Idempotent per (source_key, source_ref); a different value under the same reference is 409. Services only.</p>GET /api/v1/watchlists
Read the watchlists of the person in X-OV-Subject (never anyone else's: another person's watchlist is 404).
- Capabilities
- trade.watchlist.read
- Visibility
- first-party
- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.read</strong> (first-party): Read the watchlists of the person in X-OV-Subject (never anyone else's: another person's watchlist is 404).</p>POST /api/v1/watchlists
Create a private watchlist for the person in X-OV-Subject.
- Capabilities
- trade.watchlist.create
- Visibility
- first-party
- Request body
application/jsontrade.watchlist-request@1- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.create</strong> (first-party): Create a private watchlist for the person in X-OV-Subject.</p>GET /api/v1/watchlists/{id}
Read the watchlists of the person in X-OV-Subject (never anyone else's: another person's watchlist is 404).
- Capabilities
- trade.watchlist.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.read</strong> (first-party): Read the watchlists of the person in X-OV-Subject (never anyone else's: another person's watchlist is 404).</p>PATCH /api/v1/watchlists/{id}
Rename a watchlist of the person in X-OV-Subject, or add and remove instruments on it.
- Capabilities
- trade.watchlist.update
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsontrade.watchlist-request@1- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.update</strong> (first-party): Rename a watchlist of the person in X-OV-Subject, or add and remove instruments on it.</p>DELETE /api/v1/watchlists/{id}
Delete a watchlist of the person in X-OV-Subject.
- Capabilities
- trade.watchlist.delete
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsontrade.deleted-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.delete</strong> (first-party): Delete a watchlist of the person in X-OV-Subject.</p>PUT /api/v1/watchlists/{id}/items/{symbol}
Rename a watchlist of the person in X-OV-Subject, or add and remove instruments on it.
- Capabilities
- trade.watchlist.update
- Visibility
- first-party
- Parameters
id(path, required)symbol(path, required)
- Request body
application/jsontrade.watchlist-request@1- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>trade.watchlist.update</strong> (first-party): Rename a watchlist of the person in X-OV-Subject, or add and remove instruments on it.</p>DELETE /api/v1/watchlists/{id}/items/{symbol}
Rename a watchlist of the person in X-OV-Subject, or add and remove instruments on it.
- Capabilities
- trade.watchlist.update
- Visibility
- first-party
- Parameters
id(path, required)symbol(path, required)
- Input
- trade.watchlist-request@1
- Response
application/jsontrade.watchlist-result@1- Errors
- errors.problem@1 (application/problem+json)