Skip to content

chore(sync): update api from mother repository #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NomadDigita merged 1 commit into from
Oct 21, 2026
Merged

chore(sync): update api from mother repository #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The live, versioned REST API is at `https://api.tidelight.app/v1`. The OpenAPI 3
| Operation | Scope | Purpose |
| --- | --- | --- |
| `GET /market/instruments` | `market:read` | List supported Reality tokenized-equity spot instruments; optionally filter by `underlying_ticker` before pagination |
| `POST /research/jobs` | `research:run` | Start an asynchronous, idempotent company snapshot |
| `POST /research/jobs` | `research:run` | Start an asynchronous, idempotent company snapshot with 30-day headline discovery |
| `GET /research/jobs/{job_id}` | `research:run` | Read status/result within the key's project |
| `DELETE /research/jobs/{job_id}` | `research:run` | Cancel queued work or request cancellation |
| `GET, POST /webhooks` | `alerts:manage` | List or create research event subscriptions |
Expand All @@ -26,7 +26,7 @@ curl --fail-with-body \
'https://api.tidelight.app/v1/market/instruments?kind=rtoken&underlying_ticker=AAPL&limit=10'
```

Responses include a request ID and market provenance, including the provider source and timestamp. rToken spot instruments are tokenized products; they are not underlying shares or stock perpetual contracts. An unavailable provider returns a safe service error instead of fabricated values. Bitget-backed market responses fail closed with `503 provider_terms_unconfirmed` until written redistribution permission is confirmed and configured. Async research responses include a job ID; reuse the same `Idempotency-Key` when retrying a start request.
Research snapshots perform eight bounded news-feed searches over earnings, guidance, regulation, industry, and supply-chain topics. Dated headlines are filtered to 30 days and returned with retrieval time, publisher counts, and original links. Coverage is bounded, not exhaustive; headlines and snippets are discovery references, not full article analysis. Responses include a request ID and market provenance, including the provider source and timestamp. rToken spot instruments are tokenized products; they are not underlying shares or stock perpetual contracts. An unavailable provider returns a safe service error instead of fabricated values. Bitget-backed market responses fail closed with `503 provider_terms_unconfirmed` until written redistribution permission is confirmed and configured. Async research responses include a job ID; reuse the same `Idempotency-Key` when retrying a start request.

Errors use a stable code, safe message, and request ID. Respect `429` quotas and only retry safe operations or idempotent requests. All request and response schemas, status codes, limits, and OAuth-free API-key requirements are defined by the OpenAPI contract.

Expand Down
14 changes: 12 additions & 2 deletions openapi/tidelight.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,10 +331,20 @@ components:
stock_perpetual: { oneOf: [{ $ref: '#/components/schemas/StockPerpetual' }, { type: 'null' }] }
evidence:
type: object
required: [mode, note, items]
required: [mode, note, coverage, items]
properties:
mode: { type: string, const: headline_discovery }
mode: { type: string, const: multi_query_headline_discovery }
note: { type: string }
coverage:
type: object
required: [query_count, lookback_days, retrieved_at, returned_items, publishers]
properties:
query_count: { type: integer, minimum: 0 }
lookback_days: { type: integer, const: 30 }
retrieved_at: { type: string, format: date-time }
returned_items: { type: integer, minimum: 0 }
publishers: { type: integer, minimum: 0 }
source_domains: { type: integer, minimum: 0 }
items: { type: array, items: { $ref: '#/components/schemas/HeadlineReference' } }
limitations: { type: array, items: { type: string } }
StockPerpetual:
Expand Down
Loading