fAlpha · JSON-LD Context
Falpha Ai Context
JSON-LD context defining the semantic vocabulary for Falpha Ai from fAlpha.
23 Classes
82 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
falpha:
https://falpha.ai/schema#
Classes
HTTPValidationError
ValidationError
account_response
article_response
articles_list_response
available_tickers_response
driver
event
events_response
performance_metrics
quality_metrics
screener_response
screener_row
sector_entry
sectors_response
sentiment_reading
sentiment_summary
signal_card
signal_history
signal_item
ticker_metrics
usage_bucket
usage_response
Properties
| Property | Type | Container |
|---|---|---|
| detail | list | |
| loc | list | |
| msg | string | |
| type | string | |
| is_admin | boolean | |
| is_enterprise | boolean | |
| api_disabled | boolean | |
| role | ||
| billing | ||
| date | string | |
| title | string | |
| score | ||
| source | ||
| summary | ||
| link | string | |
| ticker | string | |
| count | integer | |
| articles | list | |
| available_tickers | list | |
| name | string | |
| weight_pct | decimal | |
| direction | string | |
| id | string | |
| previous_date | ||
| period | ||
| horizon_label | ||
| regime | ||
| signal | ||
| confidence | ||
| previous_confidence | ||
| from_signal | ||
| to_signal | ||
| threshold | ||
| crossed | ||
| sentiment | ||
| previous_sentiment | ||
| change | ||
| shift | ||
| signal_date | ||
| rank | ||
| rank_by | ||
| top | ||
| quality | ||
| url | string | |
| since | string | |
| as_of | ||
| events | list | |
| pnl | ||
| ticker_return | ||
| index_return | ||
| release_date | ||
| sharpe_ratio | ||
| sortino_ratio | ||
| iis_score | ||
| normalized_iis | ||
| percent_positive_pnl | ||
| sector | ||
| scanned | integer | |
| universe | string | |
| universe_note | ||
| results | list | |
| key | string | |
| sectors | list | |
| previous_score | ||
| average | decimal | |
| trend | string | |
| readings | list | |
| hp | string | |
| drivers | list | |
| drivers_flat | ||
| drivers_note | ||
| predictions | list | |
| performance | ||
| metrics | reference | |
| window_days | integer | |
| total | integer | |
| by_day | list | |
| by_endpoint | list | |
| by_surface | list | |
| by_client | list | |
| meter |
JSON-LD Document
{
"@context": {
"@vocab": "https://falpha.ai/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"falpha": "https://falpha.ai/schema#",
"HTTPValidationError": "falpha:HTTPValidationError",
"detail": {
"@id": "falpha:detail",
"@container": "@list"
},
"ValidationError": "falpha:ValidationError",
"loc": {
"@id": "falpha:loc",
"@container": "@list"
},
"msg": {
"@id": "falpha:msg",
"@type": "xsd:string"
},
"type": {
"@id": "falpha:type",
"@type": "xsd:string"
},
"account_response": "falpha:account_response",
"email": {
"@id": "falpha:email"
},
"is_admin": {
"@id": "falpha:is_admin",
"@type": "xsd:boolean"
},
"is_enterprise": {
"@id": "falpha:is_enterprise",
"@type": "xsd:boolean"
},
"api_disabled": {
"@id": "falpha:api_disabled",
"@type": "xsd:boolean"
},
"role": {
"@id": "falpha:role"
},
"billing": {
"@id": "falpha:billing"
},
"article_response": "falpha:article_response",
"date": {
"@id": "falpha:date",
"@type": "xsd:string"
},
"title": {
"@id": "falpha:title",
"@type": "xsd:string"
},
"score": {
"@id": "falpha:score"
},
"source": {
"@id": "falpha:source"
},
"summary": {
"@id": "falpha:summary"
},
"link": {
"@id": "falpha:link",
"@type": "xsd:string"
},
"articles_list_response": "falpha:articles_list_response",
"ticker": {
"@id": "falpha:ticker",
"@type": "xsd:string"
},
"count": {
"@id": "falpha:count",
"@type": "xsd:integer"
},
"articles": {
"@id": "falpha:articles",
"@container": "@list"
},
"available_tickers_response": "falpha:available_tickers_response",
"available_tickers": {
"@id": "falpha:available_tickers",
"@container": "@list"
},
"driver": "falpha:driver",
"name": {
"@id": "falpha:name",
"@type": "xsd:string"
},
"weight_pct": {
"@id": "falpha:weight_pct",
"@type": "xsd:decimal"
},
"direction": {
"@id": "falpha:direction",
"@type": "xsd:string"
},
"event": "falpha:event",
"id": {
"@id": "falpha:id",
"@type": "xsd:string"
},
"previous_date": {
"@id": "falpha:previous_date"
},
"period": {
"@id": "falpha:period"
},
"horizon_label": {
"@id": "falpha:horizon_label"
},
"regime": {
"@id": "falpha:regime"
},
"signal": {
"@id": "falpha:signal"
},
"confidence": {
"@id": "falpha:confidence"
},
"previous_confidence": {
"@id": "falpha:previous_confidence"
},
"from_signal": {
"@id": "falpha:from_signal"
},
"to_signal": {
"@id": "falpha:to_signal"
},
"threshold": {
"@id": "falpha:threshold"
},
"crossed": {
"@id": "falpha:crossed"
},
"sentiment": {
"@id": "falpha:sentiment"
},
"previous_sentiment": {
"@id": "falpha:previous_sentiment"
},
"change": {
"@id": "falpha:change"
},
"shift": {
"@id": "falpha:shift"
},
"signal_date": {
"@id": "falpha:signal_date"
},
"rank": {
"@id": "falpha:rank"
},
"rank_by": {
"@id": "falpha:rank_by"
},
"top": {
"@id": "falpha:top"
},
"quality": {
"@id": "falpha:quality"
},
"url": {
"@id": "falpha:url",
"@type": "xsd:string"
},
"events_response": "falpha:events_response",
"since": {
"@id": "falpha:since",
"@type": "xsd:string"
},
"as_of": {
"@id": "falpha:as_of"
},
"events": {
"@id": "falpha:events",
"@container": "@list"
},
"performance_metrics": "falpha:performance_metrics",
"pnl": {
"@id": "falpha:pnl"
},
"ticker_return": {
"@id": "falpha:ticker_return"
},
"index_return": {
"@id": "falpha:index_return"
},
"release_date": {
"@id": "falpha:release_date"
},
"quality_metrics": "falpha:quality_metrics",
"sharpe_ratio": {
"@id": "falpha:sharpe_ratio"
},
"sortino_ratio": {
"@id": "falpha:sortino_ratio"
},
"iis_score": {
"@id": "falpha:iis_score"
},
"normalized_iis": {
"@id": "falpha:normalized_iis"
},
"percent_positive_pnl": {
"@id": "falpha:percent_positive_pnl"
},
"screener_response": "falpha:screener_response",
"sector": {
"@id": "falpha:sector"
},
"scanned": {
"@id": "falpha:scanned",
"@type": "xsd:integer"
},
"universe": {
"@id": "falpha:universe",
"@type": "xsd:string"
},
"universe_note": {
"@id": "falpha:universe_note"
},
"results": {
"@id": "falpha:results",
"@container": "@list"
},
"screener_row": "falpha:screener_row",
"sector_entry": "falpha:sector_entry",
"key": {
"@id": "falpha:key",
"@type": "xsd:string"
},
"sectors_response": "falpha:sectors_response",
"sectors": {
"@id": "falpha:sectors",
"@container": "@list"
},
"sentiment_reading": "falpha:sentiment_reading",
"sentiment_summary": "falpha:sentiment_summary",
"previous_score": {
"@id": "falpha:previous_score"
},
"average": {
"@id": "falpha:average",
"@type": "xsd:decimal"
},
"trend": {
"@id": "falpha:trend",
"@type": "xsd:string"
},
"readings": {
"@id": "falpha:readings",
"@container": "@list"
},
"signal_card": "falpha:signal_card",
"hp": {
"@id": "falpha:hp",
"@type": "xsd:string"
},
"drivers": {
"@id": "falpha:drivers",
"@container": "@list"
},
"drivers_flat": {
"@id": "falpha:drivers_flat"
},
"drivers_note": {
"@id": "falpha:drivers_note"
},
"signal_history": "falpha:signal_history",
"predictions": {
"@id": "falpha:predictions",
"@container": "@list"
},
"signal_item": "falpha:signal_item",
"performance": {
"@id": "falpha:performance"
},
"ticker_metrics": "falpha:ticker_metrics",
"metrics": {
"@id": "falpha:metrics",
"@type": "@id"
},
"usage_bucket": "falpha:usage_bucket",
"usage_response": "falpha:usage_response",
"window_days": {
"@id": "falpha:window_days",
"@type": "xsd:integer"
},
"total": {
"@id": "falpha:total",
"@type": "xsd:integer"
},
"by_day": {
"@id": "falpha:by_day",
"@container": "@list"
},
"by_endpoint": {
"@id": "falpha:by_endpoint",
"@container": "@list"
},
"by_surface": {
"@id": "falpha:by_surface",
"@container": "@list"
},
"by_client": {
"@id": "falpha:by_client",
"@container": "@list"
},
"meter": {
"@id": "falpha:meter"
}
},
"@type": "schema:Dataset",
"schema:name": "fAlpha API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects fAlpha's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-07) from openapi/falpha-ai-openapi.json.",
"dcterms:created": "2026-11-07",
"dcterms:source": [
"openapi/falpha-ai-openapi.json"
]
}